In diesem Artikel wird erläutert, was eine Public Application Programming Interface (API) ist, wofür Sie die API für individuelle Berichte verwenden können und wie Sie API-Anmeldedaten dafür generieren.

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 der API für individuelle Berichte tun?

Mit der API für individuelle Berichte können Sie erweiterte Analysen und Berichte erstellen. 

Je nach Endpunkt können Sie mithilfe dieser API:

• • • • • eine Liste aller vorhandenen individuellen Berichte in Ihrem Personio-Konto abrufen (GetReports-Endpunkt),
        • eine Liste aller vorhandenen Berichtstabellenspalten abrufen (GetColumns-Endpunkt), und
        • Daten eines bestimmten individuellen Berichts im JSON-Format abrufen (GetReportData-Endpunkt).

Mit anderen Worten: Die API für individuelle Berichte ermöglicht es Ihnen, Personio HR-Daten mit anderen Datensätzen zusammenzuführen, sie in einem Data Warehouse zu speichern und in einem Business-Intelligence-Tool (BI-Tool) weiter zu verarbeiten.

Beispiel:
Sie können die API für individuelle Berichte verwenden, um historische Mitarbeitendendaten und auch die Anzahl an Überstunden abzurufen, die Ihre Mitarbeitenden in einem bestimmten Monat geleistet haben.

Hinweis:
Die API für individuelle Berichte erlaubt derzeit nicht das Erstellen oder Bearbeiten eines vorhandenen individuellen Berichts.

API-Zugriffsdaten erstellen

1. 1. Gehen Sie zu Einstellungen > Integrationen > API-Anmeldedaten.
   2. Klicken Sie auf Neue Anmeldedaten generieren.
   3. Die Seitenleiste Neue Anmeldedaten hinzufügen wird angezeigt. Geben Sie im Feld Name einen aussagekräftigen Namen (z. B. Anmeldedaten für individuelle Berichte) für die API-Anmeldedaten ein.
   4. Wählen Sie gegebenenfalls eine Integration aus dem Drop-Down-Menü Integration aus. Wenn nicht, wählen Sie Andere aus.
   5. Aktivieren Sie die Checkbox Lesen für die API für individuelle Berichte.
      

      Tipp:
      Erfahren Sie mehr über die verschiedenen Checkboxen im Artikel API-Anmeldedaten generieren und verwalten.

   6. Klicken Sie auf Neue Anmeldedaten generieren.
   7. Es wird eine Meldung angezeigt, die bestätigt, dass die neuen API-Anmeldedaten erstellt wurden.

   

   Tipp:
   Alternativ können Sie auch den Endpunkt Lesen für individuelle Berichte für vorhandene API-Anmeldedaten aktivieren. Gehen Sie zu Einstellungen > Integrationen > API-Anmeldedaten, klicken Sie auf Anmeldedaten und aktivieren Sie das Kontrollkästchen bei Individuelle Berichte.
   

   Hinweis:
   Alle vorhandenen Berichte können abgerufen werden, wenn der Endpunkt Lesen aktiviert ist. Darüber hinaus wird der Abschnitt Lesbare Mitarbeitendenattribute für die Personaldaten-API für den Endpunkt Individuelle Berichte nicht berücksichtigt. Alle Attribute, die einem individuellen Bericht hinzugefügt wurden, können über den Endpunkt abgerufen werden, wenn er für die entsprechenden Anmeldedaten aktiviert ist, unabhängig davon, ob das Attribut auf der Whitelist steht oder nicht. 

   Hinweis
   Berichte, die 60 Tage lang nicht über die API für benutzerdefinierte Berichte abgerufen werden, wechseln automatisch in den Status Archiviert. Diese Berichte werden erst dann wieder automatisch aktualisiert, wenn sie über die Personio-App abgerufen und so erneut aktiviert werden. 

Technische Dokumentation

Die gesamte Dokumentation für unsere API für individuelle Berichte, einschließlich Endpunkte, Informationen über die genauen übertragenen Daten und technische Tutorials, ist in unserem Developer Hub verfügbar.