In diesem Artikel wird erläutert, was eine Public Application Programming Interface (API) ist, wofür Sie die Recruiting-API verwenden können und wie Sie API-Zugriffsdaten dafür generieren.
Was ist eine öffentliche API in Personio?
APIs ermöglichen den Datenaustausch zwischen Personio und einem anderen Dienst oder Tool. So können Sie Verbindungen zwischen Personio und Ihren eigenen Datenbanken aufbauen oder Integrationen mit Drittanbietern einrichten, die im Personio Marketplace verfügbar sind. Personio bietet drei öffentliche APIs: Recruiting, Personaldaten und Individuelle Berichte.
Hinweis
Um die Recruiting-API zu integrieren, sollten Sie sich an eine auf IT spezialisierte Person wenden.
Welche Möglichkeiten bietet Ihnen Personios Recruiting-API?
Personios Recruiting-API ermöglicht insbesondere den Austausch von Daten über Stellen und Bewerbende:
▶︎ Stellen aus Personio abrufen (keine Zugriffsdaten erforderlich): Über XML können Sie Daten zu Stellen abrufen, die Sie in Personio veröffentlicht haben, und diese Stellen auf Ihrer unternehmenseigenen Karriereseite anzeigen. Erfahren Sie mehr darüber, wie Sie Stellen aus Personio über XML mit der Website Ihres Unternehmens integrieren.
▶︎ Bewerbungen an Personio senden (Zugriffsdaten erforderlich): Übertragen Sie Bewerbungen und Bewerbendendaten (wie den Bewerbendennamen, das Bewerbungsdatum, Dokumente, ...) automatisch aus Ihrem eigenen Bewerbungsformular an Personio und erstellen Sie ein Bewerbendenprofil. Erfahren Sie mehr darüber, wie Sie Bewerbendendaten in Ihr Personio-Konto einspielen.
API-Zugriffsdaten abrufen
Für diese öffentliche API werden Ihre Zugriffsdaten vom System generiert und sind in Ihrem Konto verfügbar. Sie finden diese unter Einstellungen > Integrationen > API-Zugriffsdaten > Recruiting-API-Schlüssel. Hier liegen sowohl Ihre Unternehmens-ID als auch der Zugriffs-Token für Ihre Recruiting-API.
Stellen aus Personio abrufen
Rufen Sie über eine GET-Anfrage Informationen zu Ihren veröffentlichten Stellen aus Ihrem XML-Feed ab und binden Sie diese in Ihre Website ein. Die URL hierfür lautet ihrkonto.jobs.personio.de/xml.
Nachdem Ihre Stellen auf Ihrer Karriereseite angezeigt werden, müssen die eingehenden Bewerbungen über die Personio-Recruiting-API (in Form von Anfragen und Antworten) eingespielt werden:
Bewerbungen in Personio einspielen
Um eine POST-Anfrage an Personio zu senden, verwenden Sie die folgende URL: https://api.personio.de/v1/recruiting/applications.
Obligatorisch benötigte Parameter für den Text der POST-Anfrage
| Parameter | Notizen |
| company_id | Zu finden unter: Einstellungen > Integrationen > API-Zugriffsdaten |
| access_token | Zu finden unter: Einstellungen > Integrationen > API-Zugriffsdaten |
| job_position_id | Zu finden unter: ihrkonto.jobs.personio.de/xml |
| first_name | Eingespielt über das Bewerbungsformular |
| last_name | Eingespielt über das Bewerbungsformular |
| Eingespielt über das Bewerbungsformular | |
| application_date | Eingespielt über das Bewerbungsformular |
| Phase | System- oder individuelle Phase |
Tipp
Wir empfehlen, die job_position_id automatisch aus dem aktivierten XML-Feed zu ziehen (GET) und in die POST-Anfrage zu integrieren.
Optionale Parameter für den Text der POST-Anfrage
Personio akzeptiert auch die folgenden optionalen Parameter:
| Parameter | Notizen |
| Birthday | Eingespielt über das Bewerbungsformular |
| Dokumente | Eingespielt über das Bewerbungsformular |
Hinweise
▶ ︎Sie können Bewerbendendokumente entweder massenweise in einem sogenannten Array oder einzeln übertragen. Erfahren Sie mehr darüber in unserem Developer Hub.
▶ ︎Die maximale Größe pro Dokument, das über die Recruiting-API empfangen wird, beträgt 20 MB.
▶ ︎Die folgenden Formate werden unterstützt: 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.
Individuelle Attribute einspielen
Zudem können Sie über die API auch Werte für alle Bewerbendenattribute, die Sie einzeln unter Einstellungen > Recruiting > Recruiting > Attribute angelegt haben, in Personio hinzufügen.
Dafür ist notwendig, dass Sie über den API-Attributnamen eine Verbindung zum Bewerbendenattribut herstellen.
Bewerbungskanal einspielen
Des Weiteren haben Sie die Möglichkeit, den Kanal zu übergeben, über welchen die Bewerbung eingegangen ist.
Integrieren Sie dafür den Parameter recruiting_channel_id in Ihre POST-Anfrage. Die ID des Kanals finden Sie unter Einstellungen > Recruiting > Recruiting > Kanäle:
Hinweis
Wenn Sie eine Stelle auf einer externen Jobbörse posten, müssen Sie den Parameter external_posting_id zu Ihrer POST-Anfrage hinzufügen. Somit können Sie zurückverfolgen, über welche Jobbörse die Bewerbung eingegangen ist. Weitere Informationen hierzu finden Sie in unserem Developer Hub: Bewerbungen in Personio anlegen.
Technische Dokumentation
Eine komplette Liste aller Parameter, sowie zusätzliche Informationen dazu, finden Sie in unserem Developer Hub.