In dit artikel wordt uitgelegd wat een openbare Application Programming Interface (API) is, waarvoor je de wervings-API kunt gebruiken, en hoe je daarvoor API-referenties genereert.
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 drie openbare API's: werving en selectie, personeelsgegevens en gepersonaliseerde rapporten.
Opmerking
Om de wervings-API te integreren, moet je een IT-expert raadplegen.
Wat kun je doen met de wervings-API van Personio?
De wervings-API van Personio maakt de uitwisseling van gegevens over functies en kandidaten mogelijk:
▶︎ Functies ophalen uit Personio (geen referenties nodig): je kunt gegevens ophalen van functies die je in Personio hebt gepubliceerd via XML, en deze weergeven op de carrièrepagina van je eigen bedrijf. Lees meer over het integreren van functies uit Personio in je bedrijfswebsite via XML.
▶︎ Sollicitaties doorsturen naar Personio (referenties vereist): je kunt sollicitaties en kandidaatgegevens (zoals naam, sollicitatiedatum, documenten, ...) van je eigen sollicitatieformulier automatisch doorsturen naar Personio en een kandidaatprofiel aanmaken. Lees hier meer over het doorsturen van kandidaatgegevens naar je Personio-account
Je API-referenties vinden
Voor deze openbare API worden je referenties door het systeem gegenereerd. Je kunt ze vinden in je account via Instellingen > Integraties > API-referenties > API-sleutel werving en selectie. Daar vind je zowel je bedrijfs-ID als je toegangstoken voor de wervings-API.
Functies ophalen uit Personio
Gebruik een GET-verzoek om informatie over je geplaatste vacatures op te halen uit je XML-feed en te integreren in je website. De URL hiervoor is jouwaccount.jobs.personio.de/xml.
Als je vacatures eenmaal op je carrièrepagina worden weergegeven, moeten inkomende sollicitaties via de wervings-API van Personio (in de vorm van aanvragen en antwoorden) worden doorgestuurd naar Personio:
Sollicitaties doorsturen naar Personio
Gebruik de volgende URL om een POST-verzoek naar Personio te sturen: https://api.personio.de/v1/recruiting/applications
Verplichte parameters voor de inhoud van het POST-verzoek
| Parameter | Uitleg |
| company_id | Hier te vinden: Instellingen > Integraties > API-referenties |
| access_token | Hier te vinden: Instellingen > Integraties > API-referenties |
| job_position_id | Hier te vinden: jouwacount.jobs.personio.de/xml |
| first_name | Overgedragen via het sollicitatieformulier |
| last_name | Overgedragen via het sollicitatieformulier |
| Overgedragen via het sollicitatieformulier | |
| application_date | Overgedragen via het sollicitatieformulier |
| Fase | Kan een systeemfase of zelfgemaakte fase zijn |
Tip: Wij adviseren dat je de job_position_id automatisch ophaalt uit de geactiveerde XML-feed (GET) en integreert in het POST-verzoek.
Optionele parameters voor de inhoud van het POST-verzoek
Personio accepteert ook de volgende optionele parameters:
| Parameter | Uitleg |
| Verjaardag | Overgedragen via het sollicitatieformulier |
| Documenten | Overgedragen via het sollicitatieformulier |
Opmerkingen
▶︎ Je kunt documenten van kandidaten individueel verzenden of in één keer in een zogenaamde 'array'. Lees hier meer over in onze Developer Hub.
▶︎ De maximale grootte van een document dat via de wervings-API wordt ontvangen is 20 MB.
▶︎ De volgende formaten worden ondersteund: pdf, docx, doc, png, jpg, jpeg, txt, odt, ods, xlsx, rtf, xls, pptx, ppt, gif, tif, tiff, bmp, csv, rar, gz, zip, 7z, mp4, 3gp, mov, avi, wmv.
Aangepaste attributen verzenden
Je kunt de API ook gebruiken om waarden toe te voegen aan Personio voor alle kandidaatattributen die je hebt aangemaakt in Instellingen > Werving & Selectie > Werving & Selectie > Attributen.
Daarvoor moet je het kandidaatattribuut koppelen via de API-attribuutnaam. Je vindt deze naam in de bewerkingsmodus voor het kandidaatattribuut:
Het sollicitatiekanaal doorsturen
Je kunt ook het kanaal doorgeven waarvan de sollicitatie afkomstig is.
Neem daarvoor de parameter recruiting_channel_id op in je POST-aanvraag. Je vindt de kanaal-ID onder Instellingen > WERVING & SELECTIE > Werving & Selectie > Kanalen.
Opmerking
Als je een vacature op een externe jobboard plaatst, moet je de parameter external_posting_id aan je POST-verzoek toevoegen. Zo kun je nagaan van welke jobboard de sollicitatie afkomstig is. Meer informatie vind je in onze Developer Hub: Creating applications in Personio.
Technische documentatie
Een volledige lijst van alle parameters en andere relevante informatie is te vinden in onze Developer Hub.