In diesem Artikel wird erläutert, was eine Public Application Programming Interface (API) ist, wofür Sie die API für benutzerdefinierte Berichte 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. 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 benutzerdefinierte Berichte und die vier Personaldaten-APIs (Mitarbeiter, Abwesenheiten, Anwesenheiten und Dokumente) .

Was können Sie mit der API für benutzerdefinierte Berichte tun?

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

Je nach Endpunkt können Sie mithilfe dieser API:

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

Mit anderen Worten: Die API für benutzerdefinierte 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 benutzerdefinierte Berichte verwenden, um historische Mitarbeiterdaten und auch die Anzahl an Überstunden abzurufen, die Ihre Mitarbeiter in einem bestimmten Monat geleistet haben.

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

API-Zugriffsdaten erstellen

1. 1. Gehen Sie zu Einstellungen > Integrationen > API-Zugriffsdaten.
   2. Klicken Sie auf Neue Zugriffsdaten generieren.
   3. Die Seitenleiste Neue Zugriffsdaten hinzufügen wird angezeigt. Geben Sie im Feld Name einen aussagekräftigen Namen (z. B. Zugriffsdaten für benutzerdefinierte Berichte) für die API-Zugriffsdaten 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 benutzerdefinierte Berichte.
      

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

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

   

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

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

    

   Technische Dokumentation

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