API Update 2022-11

[#1]

De afgelopen periode zijn er weer een aantal verbeteringen in de API's doorgevoerd.

API's nu ook beschikbaar via Visma developer portal

De Visma developer portal is binnen de Visma groep de centrale plaats voor delen en publiceren van API's uit de Visma groep voor derden.  Om hierbij aan te sluiten hebben we de afgelopen periode de IAM en Learning API op de Visma developer portal gepubliceerd. 
De IAM en Learning API is ook nog beschikbaar via de oude Raet developer portal waardoor bestaande integraties niet zullen wijzigen.

Voor nieuwe integraties zal er door de API consultant veelal voor gekozen worden om deze via de nieuwe Visma developer Portal te ontsluiten.  Ook nieuwe API zullen in de toekomst enkel nog via deze nieuwe Portal gepubliceerd worden.  
Onze API consultants zullen developers en klanten tijdens de implementatie hierbij begeleiden.

Een uitgebreide beschrijving voor het aanmaken van een account staat beschreven op de deze pagina. Wij adviseren uit echter om vooraf eerst contact op te nemen met onze API consultant (api.consulting.raet@visma.com). Zij kunnen aanvullende uitleg geven over het gebruik van de Visma Developer portal.

Extension API toegevoegd aan Visma developer portal

In de nieuwe Visma Developer portal is de Extensie API  als uitbreiding op een domein API, zoals zoals de IAM of Learning API, beschikbaar gekomen. Met deze extensie API is het mogelijk om extra velden aan de domein API toe te voegen. Bijvoorbeeld het toevoegen van een klant eigen rubriek behorende bij de persoon of het dienstverband.

De extensie API dient altijd in combinatie met één van de domein API gebruikt te worden. Tevens kunnen enkel niet-ingedeelde rubrieken op het niveau Persoon of Dienstverband aan de API toegevoegd worden. Het toevoegen van extra velden kan op dit moment geregeld worden door een API consultant.  Uiteraard geldt wel dat het ontvangende systeem ook met extra velden en endpoints overweg moet kunnen gaan. Een uitgebreide beschrijving is te vinden op deze pagina

De extensies kunnen per per klant en domain API verschillend. Voor respectievelijk de IAM en learning API hebben wij de volgende endpoints beschikbaar.

api.youforce.com/extensions/v1.0/IAM/persons 
api.youforce.com/extensions/v1.0/IAM/employments 
api.youforce.com/extensions/v1.0/learning/persons 
api.youforce.com/extensions/v1.0/learning/employments

Afhankelijk van de gekozen endpoint worden de extensies op persoons- of dienstverband niveau weergegeven.  Indien de rubriek in Beaufort bestaat uit veld met een referentie tabel dan wordt ook de bijbehorende omschrijving uit de referentietabel in het endpoint weergegeven. Zie onderstaand voorbeeld bij rubriek API002.