In diesem Artikel wird erläutert, was ein Public Application Programming Interface (API) ist, wofür Sie die verschiedenen Personaldaten-APIs verwenden, und wie Sie API-Zugriffsdaten generieren können.
Was ist eine öffentliche API in Personio?
APIs ermöglichen den Datenaustausch zwischen Personio und einem anderen Dienst oder Tool. Auf diese Weise 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 derzeit mehrere öffentliche APIs an: die Recruiting-API, die API für individuelle Berichte und die vier Personaldaten-APIs (Mitarbeitende, Abwesenheiten, Anwesenheiten und Dokumente) .
Was können Sie mit den verschiedenen Personaldaten-APIs machen?
Insbesondere die Personaldaten-APIs ermöglichen den Austausch von Informationen über Mitarbeitendendaten, Dokumente, Anwesenheiten und Abwesenheiten.
Abhängig von der spezifischen API können Sie Folgendes tun:
-
Mitarbeitenden-API
▶ ︎Mitarbeitendendaten aus Personio abrufen.
▶ ︎Neue Mitarbeitende in Personio anlegen.
▶ ︎Bestehende Mitarbeitendendaten in Personio aktualisieren.
Beispiel:
Sie können die MS Teams-Integration verwenden, um Ihre Mitarbeitenden in einem ausgewählten Kanal über Jubiläen und Geburtstage zu informieren. -
Anwesenheiten-API
▶ ︎ Anwesenheitsdaten aus Personio abrufen (einschl. der Projekt-ID).
▶ ︎Neue Anwesenheiten in Personio erstellen.
▶ ︎Bestehende Anwesenheiten in Personio aktualisieren.
▶ ︎Anwesenheiten in Personio löschen.
Beispiel:
Sie können die AskDante-Integration verwenden, um die Anwesenheiten Ihrer Mitarbeitenden zu erfassen. In dieser Anwendung erfasste Daten zu Start- und Endzeiten sowie zu Anwesenheitspausen können dann in Personio übertragen werden. -
Abwesenheiten-API
▶ ︎Abwesenheitsdaten aus Personio abrufen.
▶ ︎Neue Abwesenheiten in Personio erstellen.
▶ ︎Abwesenheiten in Personio löschen.
Beispiel:
Sie können die Slack-Integration nutzen, um es Ihren Mitarbeitenden zu ermöglichen, Abwesenheiten direkt über Slack zu beantragen. -
Dokumente-API
▶ Daten zu Dokumentkategorien aus Personio abrufen.▶ ︎ Senden eines Dokuments an ein Personio-Mitarbeitendenprofil (nur möglich nach dem Abrufen der Daten zu Dokumentkategorien).
Beispiel:
Sie können die Pento-Integration verwenden, um Entgeltabrechnungen von Pento zu erhalten und diese im jeweiligen Mitarbeitendenprofil zu speichern.
API-Zugriffsdaten erstellen
-
- Gehen Sie zu Einstellungen > Integrationen > API-Zugriffsdaten.
- Klicken Sie auf Neue Zugriffsdaten generieren.
- Die Seitenleiste Neue Zugriffsdaten hinzufügen wird angezeigt. Geben Sie im Feld Name einen aussagekräftigen Namen (z. B. Zugriffsdaten für Dokumente) für die API-Zugriffsdaten ein.
- Wählen Sie gegebenenfalls eine Integration aus dem Drop-Down-Menü Integration aus. Wenn nicht, wählen Sie Andere aus.
- Aktivieren Sie entweder die Checkbox Lesen, die Checkbox Bearbeiten oder beide für die entsprechende Personaldaten-API (Mitarbeitende, Anwesenheiten, Abwesenheiten, Dokumente). Wenn Sie die Checkbox Lesen für die Mitarbeitenden-API aktivieren, wählen Sie auch die individuellen Attribute aus, die über die API übertragen werden sollen.
Tipp:
Erfahren Sie mehr über die verschiedenen Checkboxen im Artikel So erstellen und verwalten Sie API-Zugriffsdaten für Personaldaten. - Klicken Sie auf Neue Zugriffsdaten generieren.
- Es wird eine Meldung angezeigt, die bestätigt, dass die neuen API-Zugriffsdaten erstellt wurden.
Technische Dokumentation
Die gesamte Dokumentation zu den verschiedenen Personaldaten-APIs, einschließlich Endpunkten, Informationen zu den genauen übertragenen Daten und technischen Tutorials, finden Sie in unserem Developer Hub.
Für POST und PATCH werden nur bestimmte Systemattribute unterstützt. Die unterstützten Systemattribute sind in unserem Developer Hub im Beispiel Mitarbeiter erstellenaufgelistet. Für alle anderen Systemattribute sind POST und PATCH nicht verfügbar.