Autorisatie WFM api

[#1]

Note: De WFM api  is controlled available en is nog niet beschikbaar voor algemeen gebruik.

De WFM API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Workforce Management systeem toegang heeft. 

Het autorisatie mechanisme bestaat uit de volgende onderdelen:

• Autorisatie op basis van API scopes
  Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
  
  
• Autorisatie op medewerkers 
  Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen. 

Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.  

Autorisatie op basis van API scopes
In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd.  Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.

Scope	Omschrijving	Endpoints
Invitation_only	Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd.  Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie	-
Get_Basic	Get basic data zoals medewerker- & organisatiedata	GET persons GET employments GET employmentTimelines GET assignments GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails	Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.	GET persons GET Employees Dit betreft de volgende gegevens: ADRESGEVENS Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land TELEFOONNUMMERS Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel EMAILADRES Prive: P01034 - E-mail adres privé
Get salaryDetails	Lezen van de salarisgevens van medewerkers	GET SalaryDetails GET SalaryDetailTimelines
Get_maternitityLeave	Lezen van zwangerschapverlof van medewerkers	GET maternityLeave
Get_sicknessLeave	Lezen van ziekmeldingen van medewerkers	GET sickLeave
Get_leave	Lezen van verlofrechten en verlofopnames van medewerkers	GET leaveEntitlements GET leaveHours

Uw consultant kan u helpen bij het activeren / deactiveren van deze scopes binnen de API.

Autorisatie op basis van autorisatie filters

De autorisatie filters hebben betrekking op welke medewerkers zichtbaar zijn in de API. Standaard worden altijd alle medewerkers getoond in de API. Bij het activeren van de API kan een consultant filters inrichten zodat maar een beperkte groep medewerkers via de API beschikbaar komen.

Filteren in de API is mogelijk op de volgende Beaufort velden:

• P01102- Soort Arbeidsrelatie 
• P01103- Opdrachtgever 
• P01104- Instelling 
• P01110 - Code doelgroep 
• P05042 - Selectie rubriek Domain API - WFM 

Een veel voorkomen filter is bijvoorbeeld op Soort Arbeidsrelatie waarbij alleen eigen medewerkers in het extern systeem opgenomen worden.  Maar ook een filter op de combinatie Opdrachtgever / Instelling geeft u de mogelijkheid om de medewerkers van één of meerdere specifieke instellingen in de API op te nemen.

Uw consultant kan u helpen bij het inrichten of wijzigen van de autorisatie filters.