Cet article explique ce qu’est une API publique, présente les fonctions de l’API Recrutement et décrit comment générer des identifiants pour cette API.
À quoi sert une API publique dans Personio ?
Les API permettent d’échanger des données entre Personio et un autre service ou outil. Vous pouvez alors établir des connexions entre Personio et vos propres bases de données ou configurer des intégrations avec des fournisseurs tiers disponibles sur Personio Marketplace. Personio propose trois API publiques : Recrutement, Données sur le personnel et Rapports personnalisés.
Remarque
Pour intégrer l’API Recrutement, nous vous conseillons de contacter un informaticien.
Fonctions de l’API Recrutement de Personio
L’API Recrutement de Personio permet l’échange de données sur les postes et les candidats :
▶︎ Récupérer des postes à partir de Personio (aucun identifiant requis) : vous pouvez extraire les données des postes que vous avez publiés dans Personio via XML et les afficher sur la page carrière de votre entreprise. Vous trouverez plus d’informations à ce sujet dans notre article sur l’intégration des postes de Personio à votre site web via XML.
▶︎ Transmettre les candidatures à Personio (identifiants requis) : transférez automatiquement à Personio les données sur les candidats et les candidatures (telles que le nom du candidat, la date de candidature ou des documents) qui se trouvent dans votre formulaire de candidature et créez un profil de candidat. Vous trouverez plus d’informations dans notre article sur les options pour connecter votre page carrière à Personio.
Obtenir vos identifiants API
Pour cette API publique, vos identifiants sont générés par le système et disponibles dans votre compte. Vous les trouverez sous Paramètres > Intégrations > Identifiants API > Clé API recrutement. Vous y trouverez l’identifiant de votre entreprise et votre jeton d’accès de l’API Recrutement.
Récupérer des postes à pourvoir à partir de Personio
Utilisez une requête GET pour récupérer des informations sur les postes publiés à partir de votre flux XML et intégrez ces informations dans votre site Web. L’URL de cette opération est votrecompte.jobs.personio.de/xml.
Une fois les postes à pourvoir affichés sur votre page carrière, les candidatures que vous recevez doivent être transmises à Personio via l’API Recrutement de Personio (sous forme de requêtes et de réponses) :
Transmettre les candidatures à Personio
Pour envoyer une requête POST à Personio, utilisez l’URL suivante : https://api.personio.de/v1/recruiting/applications
Paramètres obligatoires pour le corps de la requête POST
| Paramètres | Notes |
| company_id | Se trouve sous : Paramètres > Intégrations > Identifiants API |
| access_token | Se trouve sous : Paramètres > Intégrations > Identifiants API |
| job_position_id | Se trouve sous : votrecompte.jobs.personio.de/xml |
| first_name | Transféré via le formulaire de candidature |
| last_name | Transféré via le formulaire de candidature |
| Transféré via le formulaire de candidature | |
| application_date | Transféré via le formulaire de candidature |
| phase | Peut être une étape système ou personnalisée |
Conseil
Nous vous recommandons de récupérer automatiquement le paramètre job_position_id à partir du flux XML activé (GET) et de l’intégrer dans la requête POST.
Paramètres facultatifs pour le corps de la requête POST
Dans Personio, vous pouvez également utiliser les paramètres facultatifs suivants :
| Paramètres | Notes |
| Date de naissance | Transféré via le formulaire de candidature |
| Documents | Transféré via le formulaire de candidature |
Remarques
▶︎ Vous pouvez transmettre les documents des candidats de manière groupée ou individuellement. Vous trouverez plus d’informations à ce sujet dans notre Developer Hub.
▶︎ La taille maximale de chaque document reçu via l’API Recrutement est de 20 Mo.
▶︎ Les formats suivants sont acceptés : 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.
Transmettre des attributs personnalisés
Vous pouvez également utiliser l’API afin d’ajouter dans Personio les valeurs de tous les attributs du candidat que vous avez créés individuellement dans Paramètres > Recrutement > Recrutement > Attributs.
Pour ce faire, vous devez lier l’attribut du candidat via le nom de l’attribut de l’API. Vous trouverez ce nom en mode d’édition de l’attribut du candidat :
Transmettre le canal de candidature
Vous pouvez également transmettre le canal à partir duquel la candidature a été reçue.
Pour ce faire, intégrez le paramètre recruiting_channel_id dans votre requête POST. L’ID du canal se trouve sous Paramètres > RECRUTEMENT > Recrutement > Canaux :
Remarque
Si vous publiez une annonce sur un portail d’offres d'emploi, vous devrez ajouter le paramètre external_posting_id dans votre requête POST. Vous saurez ainsi de quel portail d’offres d'emploi provient la candidature. Vous trouverez plus d’informations dans notre article du Developer Hub sur la création de candidatures dans Personio.
Documentation technique
Vous trouverez la liste complète des paramètres ainsi que des informations supplémentaires dans notre Developer Hub.