Overslaan en naar hoofdcontent gaan

Waar kunnen we je mee helpen?

Terug

De personeelsgegevens-API's van Personio

 

In dit artikel wordt uitgelegd wat een openbare Application Programming Interface (API) is, waarvoor je de verschillende personeelsgegevens-API's kunt gebruiken, en hoe je daarvoor API-referenties aanmaakt.

 

Wat is een openbare API in Personio?

Met API's kunnen gegevens worden uitgewisseld tussen Personio en een andere dienst of tool. Zo kun je koppelingen maken tussen Personio en je eigen databases, of integraties instellen met externe providers die beschikbaar zijn in de Personio Marketplace.

Personio biedt momenteel verschillende openbare API's: de wervings-API, de API voor gepersonaliseerde rapporten en de vier personeelsgegevens-API's (Medewerkers, Afwezigheden, Aanwezigheid en Documenten).

 

Wat kun je doen met de verschillende personeelsgegevens-API's?

Met de personeelsgegevens-API's kan informatie worden uitgewisseld over, respectievelijk, medewerkersgegevens, documenten, aanwezigheid en afwezigheden. 

Afhankelijk van de specifieke API kun je hiermee het volgende doen:

  1. Medewerkers-API
    ▶︎     Medewerkersgegevens ophalen uit Personio;
    ▶︎ Nieuwe medewerkers aanmaken in Personio;
    ▶︎ Bestaande medewerkersgegevens bewerken in Personio.

    Voorbeeld
    Je kunt de MS Teams-integratie gebruiken om je medewerkers in een geselecteerd kanaal te informeren over verjaardagen en jubilea.

  2. Aanwezigheden-API
    ▶︎ Aanwezigheidsgegevens (inclusief project-ID) ophalen uit Personio;
    ▶︎ Nieuwe tijdregistraties aanmaken in Personio;
    ▶︎ Bestaande tijdregistraties bijwerken in Personio;
    ▶︎Tijdregistraties verwijderen in Personio.

    Voorbeeld
    Je kunt de askDante-integratie gebruiken om de werkuren van je medewerkers bij te houden. Gegevens die in deze applicatie worden bijgehouden over begin- en eindtijden en pauzes kunnen dan worden overgezet naar Personio.

  3. Afwezigheden-API
    ▶︎ Afwezigheidsgegevens ophalen uit Personio (beschikbaar voor afwezigheidstypes die in uren of in dagen worden bijgehouden).
    ▶︎ Nieuwe afwezigheden maken in Personio (beschikbaar voor afwezigheidstypes die in uren of in dagen worden bijgehouden).
    ▶︎ Afwezigheden verwijderen uit Personio (beschikbaar voor afwezigheidstypes die in uren of in dagen worden bijgehouden).

    Voorbeeld
    Met de Slack-integratie kunnen medewerkers rechtstreeks vanuit Slack een afwezigheid aanvragen.

  4. Documenten-API
    ▶︎ Informatie over documentcategorieën ophalen uit Personio;
    ▶︎ Documenten naar een Personio-medewerkersprofiel sturen (alleen mogelijk na het ophalen van de documentcategorieën).

    Voorbeeld
    Je kunt de Pento-integratie gebruiken om loonstroken van Pento te ontvangen en deze op te slaan in het betreffende medewerkersprofiel.

 

API-referenties genereren

    1. Ga naar Instellingen > Integraties > API-aanmeldgegevens.
    2. Klik op Nieuwe aanmeldgegevens aanmaken.
    3. Er verschijnt een zijbalk Nieuwe referenties toevoegen. Voer in het veld Naam een relevante naam in voor de API-referenties (bijvoorbeeld 'Aanmeldgevens documenten').
    4. Selecteer, indien van toepassing, een integratie in het keuzemenu onder Integratie, of selecteer anders Overige.
    5. Selecteer het vakje Lezen, het vakje Schrijven of beide voor de betreffende personeelsgegevens-API (Medewerkers, Aanwezigheid, Afwezigheden, Documenten). Als je het vakje Lezen selecteert voor de API Medewerkers, selecteer dan ook de attributen die via de API moeten worden overgedragen.

      Tip
      Lees meer over de verschillende vakjes in het artikel API-referenties aanmaken en beheren.

    6. Klik op Nieuwe aanmeldgegevens aanmaken.
    7. Er verschijnt een bericht om te bevestigen dat de nieuwe API-referenties zijn aangemaakt.
  2.  

Technische documentatie

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

Voor POST en PATCH worden alleen specifieke systeemattributen ondersteund. De ondersteunde systeemattributen zijn te vinden in onze Developer Hub in het voorbeeld Een medewerker aanmaken. Alle andere systeemattributen zijn niet geschikt voor POST of PATCH.