Releases Youforce API & bestandsuitwisseling

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:     WFM API Nieuwe endpoints voor Employments en Salary Details beschikbaar De WFM API is uitgebreid met 2 nieuwe endpoints voor Employments en Salary Details. Beide endpoint zijn gebaseerd op de historie tabel van Beaufort waardoor de endpoints de ingangsdatum bevat.  De nieuwe endpoints zijn: employmentTimelines salaryDetailTimelines Het endpoint employmentTimelines bevat dezelfde velden als het oorspronkelijk endpoint employments maar dus nu ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat. Hetzelfde geldt voor de endpoints salaryDetailTimelines en salaryDetails. Voor zowel het endpoint employmentTimelines als ook het endpoint SalaryDetailTimelines geldt dat data met ingangsdatum uit de historie tabel komen. In de standaard inrichting van Beaufort staat voor deze rubrieken de historie aan (zie Beaufort scherm standaard rubrieken). Onderstaand een voorbeeld van het nieuwe endpoint employmentTimelines   Op dit moment wordt de API data voor deze nieuwe endpoints één keer per dag om 18:00 UTC met Beaufort gesynchroniseerd.     Alle domein API's Het endpoint organisation units is uitgebreid met de velden indicatie geblokkeerd, kostenplaats en adresgegevens. Het endpoint organisation units van zowel de Learning, IAM als ook de WFM api is uitgebreid met de volgende API velden: isBlocked (True/false) Address  PhoneNumber CostCenterCode Deze velden komen overeen met de volgende gegevens uit Beaufort.   Note: het veld isBlocked (Inactief) wordt in Beaufort vaak gebruikt om organisatie eenheden inactief te maken tijdens een reorganisatie. Deze indicatie wordt dan gebruikt om aan te geven dat er geen nieuwe medewerkers meer op de organisatie eenheid mogen worden geplaatst. Echter bij een reorganisatie komt het regelmatig voor dat bestaande medewerkers nog herplaatst moeten worden. De indicatie IsBlocked wil dus niet zeggen dat er geen medewerkers meer aan gekoppeld zijn.     Visma Developer Portal Vanaf nu zijn alle domein API inclusief alle endpoints te gebruiken via de Visma Developer portal.  De Visma Developer Portal (https://oauth.developers.visma.com/) vervangt hiermee de oudere developer portal als de Youforce developer portal (https://developers.youforce.com/) of Raet developer portal (https://developers.raet.com/)   note:  De meest recente aanpassing betreft het endpoint Get users. Vanaf nu werkt ook dit GET users endpoint in de learning en IAM api met een Visma account uit de Visma developer portal. Heeft u nog credentials op één van de oude developer Portal dan kunt u die nog blijven gebruiken. Echter nieuwe credentials kunnen alleen nog aangemaakt worden via de Visma Developer Portal. Zie hiervoor: Aanmaken credentials Visma Developer Portal   Ook adviseren wij u om met uw applicatie over te gaan naar de nieuwe Visma Developer portal. De Visma developer portal heeft als voordeel dat u en u collega samen de apps en credentials kunt beheren.  Wel zijn daarbij enkele aandachtspunten waarmee uw development omgeving rekening moet houden, zie onderstaande tabel.    Oude Raet developer portal Oude Youforce Developer Portal Nieuwe Visma developer Portal Authencation token url:   https://api.raet.com/authentication /token  Met in de Body de volgende authenticatie gegevens uit de Raet developer portal: client_id client_secret  url:   https://api.youforce.com/authentication /token   Met in de Body de volgende authenticatie gegevens uit de Youforce developer portal: client_id client_secret  url:   https://connect.visma.com /connect/token   Met in de Body de volgende authenticatie gegevens uit de Visma developer portal: client_id client_secret  tenant_id Let op: De tenant_id is dus toegevoegd aan de authencation en wordt tussen de endpoint meegegeven in de bearer token. GET User endpoint niet beschikbaar In learning API is het endpoint beschikbaar via verschillende url versie zoals v0.1 en v.1.0 GET https://api.youforce.com//learning/v0.1/ users (employeeId=xxxx) GET https://api.youforce.com//learning/v1.0/ users (employeeId=xxxx) In de Learning en IAM is het endpoint enkel beschikbaar via de url versie v1.0 GET https://api.youforce.com//learning/v1.0/ users(employeeId=10010) All endpoints base url: api.raet.com met de volgende gegevens in de header bearer authorisation token uit het raet.com authorisation token Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert base url: api.youforce.com met de volgende gegevens in de header bearer authorisation token uit het youforce.com authorisation token Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert base url: api.youforce.com met de volgende gegevens in de header bearer authorisation token uit het visma.com authorisation token. In dit visma token zit de tenant_id al verwerkt Note: Het tenant_id hoeft dus niet meer bij elke API call meegegeven worden.  Wordt de tenant_id per ongeluk wel meegegeven in de API call dan wordt deze genegeerd  Daarnaast blijven de endpoints via de base url api.youforce.com       

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.