In dit artikel wordt uitgelegd hoe je voor de Personio-API voor personeelsgegevens en de Personio-API voor gepersonaliseerde rapporten referenties kunt genereren en beheren (bijwerken, uitschakelen, opnieuw inschakelen en verwijderen).

De referenties voor onze wervings-API worden door het systeem gegenereerd en kunnen niet worden beheerd door beheerders.

Wat zijn API-referenties in Personio?

Met API-referenties kunnen gegevens worden uitgewisseld tussen Personio en een andere dienst of tool. Zo kun je koppelingen maken tussen Personio en je eigen systeem, of integraties opzetten met externe providers die beschikbaar zijn in de Personio Marketplace. Je moet API-referenties invoeren bij het activeren van een integratie.

Opmerking
API-referenties helpen om de communicatie tussen applicaties te beveiligen, en ongeautoriseerde toegang en datalekken te voorkomen. Voor de beveiliging van gegevens wordt het aanbevolen om voor elke integratie nieuwe API-referenties te genereren.

API-referenties genereren

1. Ga naar Instellingen > Integraties > API-referenties.
2. Klik rechtsboven in het scherm op Nieuwe referenties aanmaken.
3. De zijbalk Nieuwe referenties toevoegen wordt weergegeven. Voer in het veld Naam een relevante naam in voor de referenties (bijvoorbeeld 'Greenhouse-integratie' of 'Gepersonaliseerde rapporten').
4. Selecteer, indien van toepassing, de betreffende integratie in het keuzemenu Integratie, of selecteer anders Overige.
5. Gebruik de vakjes om de gewenste toegangsniveaus in te stellen. Als je een integratie hebt geselecteerd, worden de aanbevolen toegangsniveaus vooraf geselecteerd.
   
   ▶︎ Medewerkers: selecteer Lezen om externe systemen toe te staan om medewerkersgegevens op te halen uit Personio en Schrijven om externe systemen toe te staan om gegevens in Personio aan te maken en bij te werken.
   
   ▶︎Aanwezigheden: selecteer Lezen om externe systemen toe te staan om aanwezigheidsgegevens op te halen uit Personio en Schrijven om externe systemen toe te staan om tijdregistraties in Personio aan te maken, bij te werken en te verwijderen.
   
   ▶︎Afwezigheden: selecteer Lezen om externe systemen toe te staan om afwezigheidsgegevens op te halen uit Personio en Schrijven om externe systemen toe te staan om afwezigheden in Personio aan te maken en te verwijderen.
   
   ▶︎ Documenten: selecteer Lezen om externe systemen toe te staan om documentcategorie-ID's op te halen uit Personio. Dit is nodig als je het vakje Schrijven wilt selecteren om deze externe systemen toe te staan om documenten naar een Personio-medewerkersprofiel te sturen.
   
   ▶︎ Gepersonaliseerde rapporten: selecteer Lezen om externe systemen toe te staan om alle bestaande gepersonaliseerde rapporten uit Personio op te halen. Lees meer over de Personio-API voor gepersonaliseerde rapporten.
   
   

   Opmerking
   Als je het vakje Gepersonaliseerde rapporten inschakelt, zijn alle attributen opvraagbaar die aan een gepersonaliseerd rapport zijn toegevoegd, ongeacht of het attribuut gewhitelist is onder Toegestane medewerkersattributen of niet.

6. Als je Lezen selecteert naast Medewerkers, wordt het vervolgkeuzemenu Toegestane medewerkersattributen weergegeven. Kies de medewerkersattributen die vanuit Personio moeten worden overgedragen. Als je een integratie hebt geselecteerd, worden de aanbevolen attributen vooraf geselecteerd.
   
   

   Tip
   Voor meer informatie over de toegangsniveaus die moeten worden toegewezen voor een specifieke integratie, kun je het artikel daarover lezen in onze sectie Integraties.

7. Om de API-referenties (client-ID en geheim) te genereren, klik je op Nieuwe referenties aanmaken. Er verschijnt een bericht om te bevestigen dat de referenties zijn aangemaakt.
   
   

   Opmerking
   Je hebt de client-ID en het geheim nodig om de betreffende integratie te activeren. Lees voor meer informatie ons artikel Integraties activeren vanuit de Marketplace. Je referenties kunnen worden gebruikt om toegang te krijgen tot accountgegevens. Behandel ze dus als een wachtwoord. Houd je referenties vertrouwelijk. Deel ze nooit met derden.

API-referenties beheren

API-referenties bijwerken

Volg de onderstaande stappen als je de naam van de API-referenties, de toegangsniveaus of de toegestane medewerkersattributen wilt bijwerken. De client-ID en het geheim kunnen niet worden bijgewerkt.

1. Ga naar Instellingen > Integraties > API-aanmeldgegevens.
2. Klik op de relevante referenties.
3. Er verschijnt een zijbalk waarin je de gewenste wijzigingen kunt aanbrengen.
4. Klik op Opslaan om de updates door te voeren.

API-referenties uitschakelen 

Volg deze stappen als je API-referenties tijdelijk wilt uitschakelen:

1. Ga naar Instellingen > Integraties > API-aanmeldgegevens.
2. In de lijst met alle bestaande API-referenties zet je de schakelaar naast de betreffende referenties op Uit.
3. De API-referenties zullen worden uitgeschakeld en de gegevensuitwisseling zal worden stopgezet totdat de referenties opnieuw worden ingeschakeld.

API-referenties opnieuw inschakelen

Volg de onderstaande stappen om tijdelijk uitgeschakelde API-referenties weer in te schakelen:

1. 1. Ga naar Instellingen > Integraties > API-aanmeldgegevens.
   2. In de lijst met alle bestaande API-referenties zet je de schakelaar naast de betreffende referenties op Aan.
   3. De referenties worden opnieuw ingeschakeld en de gegevensuitwisseling wordt hervat.

API-referenties verwijderen

Volg deze stappen als je API-referenties permanent wilt uitschakelen en verwijderen:

1. 1. Ga naar Instellingen > Integraties > API-aanmeldgegevens.
   2. Klik op de relevante referenties.
   3. In de zijbalk die wordt weergegeven, klik je op het prullenbakpictogram en bevestig je dat je de API-referenties wilt verwijderen.
   4. De referenties worden nu definitief verwijderd. 

Technische documentatie

Alle documentatie over onze API's, inclusief eindpunten, informatie over de precieze gegevens die worden overgedragen en technische instructies, is beschikbaar in onze Developer Hub.