API Update 2023-10

[#1]

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:

Eerste versie Basic API beschikbaar

Er is een eerste versie van de Basic API beschikbaar. Deze API is bedoeld voor systemen die niet onder een van onze standaard domein API's vallen, maar toch  basis HR gegevens nodig hebben. De Basic API bevat een set basisfunctionaliteiten met endpoints die doorgaans voldoende zijn voor integratie met het HR Core-systeem.

De Basic API bevat de volgende endpoints:

• GET Persons 
• GET Employments
• GET Organisation Units
• GET Role Assignments
• GET Job Profiles

Performance- & stabiliteitsverbeteringen

De afgelopen maand zijn er een aantal performance- en stabiliteitverbeteringen doorgevoerd . We hebben de integratie met Beaufort geoptimaliseerd, waardoor mutaties in HR Core Beaufort sneller zichtbaar zijn in de API. Deze prestatieverbetering geldt voor alle endpoint, met uitgezonderd van het employee endpoint.

Het 'employee' endpoint is gebaseerd op een verouderde infrastructuur waardoor verdere prestatieverbetering niet mogelijk is.  Als u problemen ondervindt met het 'employee' endpoint dan raden wij u aan over te stappen op het 'Person' en 'employment' endpoint voor het ophalen van de gegevens.

Tevens is de afgelopen periode de filters from/to voor het ophalen van de gewijzigde records verbeterd. In eerdere release werd nog vaak een record als gewijzigd gemarkeerd, terwijl de gegevens ongewijzigd bleek te zijn. We hebben updateproces verbeterd om te voorkomen dat onnodig veel records als gewijzigd worden gemarkeerd.  Wij verwachten dat dit de belasting op uw systeem zal verminderen, met name voor systemen die werken op basis van gewijzigde records. Deze wijziging geldt voor alle endpoint, uitgezonderd van het employee endpoint

Het employee endpoint

Zoals wij al eerder hebben aangegeven wordt het 'employee' endpoint niet verder ontwikkeld, en we raden u aan over te stappen op het 'person' en 'employment' endpoint. Het 'employee' endpoint blijft wel beschikbaar in de huidige vorm, maar verdere prestatieverbeteringen zijn niet mogelijk.

Als u momenteel het 'employee' endpoint gebruikt voor uw integratie, kan het langer duren voordat mutaties uit Beaufort zichtbaar zijn in de API.

Mocht dit in uw geval tot problemen leiden, dan adviseren wij u om de integratie om te zetten naar de 'Person' en 'Employment' endpoints. Deze endpoint bevatten dezelfde informatie als het 'employee' endpoint maar kennen dus een betere performance. Uw software leverancier kan u informeren of hun applicatie al gebruikmaakt van deze verbeterde endpoints.

Zie ook het eerdere bericht : Vervanging Employee endpoint door Persons en Employee endpoint