Zu Content springen
Deutsch
Ihre Frage kann mit keinem Artikel beantwortet werden?
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

API v2 – Programmiererschnittstelle

In folgendem Artikel erhalten Sie einen Kurzüberblick über Daten in HR WORKS auf die Sie via API zugreifen können.

Inhaltsverzeichnis

  1. Lernvideo
  2. Einführung
  3. HR WORKS API-Update als E-Mail empfangen
  4. API Dokumentation
  5. API Schlüsselpaar

 

1. Lernvideo

Schauen Sie hier das Video zum Artikel: 

 
 
 

2. Einführung

Die öffentliche HR WORKS-API v2 bietet Ihnen die Möglichkeit, mit externen Applikationen auf Daten in HR WORKS zuzugreifen, sodass Sie diese gemäß Ihrer eigenen Anforderungen weiterverarbeiten können.

Alle Daten werden im JSON-Format übertragen; Hilfestellungen zur Implementierung Ihres API-Clients sowie eine detaillierte Beschreibung aller bisher verfügbaren API-Calls finden Sie in der technischen Dokumentation.

Hinweis: Auf Wunsch bieten wir Support in Form einer API-Beratung an. Unser API-Beratungsservice richtet sich an Sie als technischen Ansprechpartner sowie an beauftragte Dienstleister. Bei inhaltlichen Anforderungen unterstützen wir auch gerne Ihre HR-Abteilung. 

Wenn Sie wissen möchten, welche Leistungen in unserem API-Beratungsservice enthalten sind, kontaktieren Sie uns gerne über unsere Support-Kanäle. 


3. HR WORKS API-Update als E-Mail empfangen

Damit Sie keine Änderungen mehr zur API verpassen, können Sie sich gerne mit dem folgenden Formular in eine E-Mail-Liste eintragen. Sobald Sie eingetragen sind, erhalten Sie mit jeder neuen Version auch die entsprechenden Änderungen bezüglich der API. Der Verteiler wird ausschließlich für die API-Updates von HR WORKS verwendet.
 

 

 

4. API Dokumentation

 Unter anderem bildet die HR WORS API folgende Funktionen zum Abrufen und ab:

  • Personenstammdaten

  • Daten zu Abwesenheiten

  • Urlaubskonto

  • Aktive und derzeit anwesende Mitarbeiter

  • Arbeitszeiten

  • Terminals und Kiosksysteme

  • Reisedaten

  • Bewerbermanagement

  • Onboarding

  • Personalakte

Sämtliche Anschlussoptionen finden Sie in unserer technischen Dokumentation.

 

5. API Schlüsselpaar

Sofern Sie die Einrichtung abgeschlossen haben, benötigen Sie zur Nutzung der Schnittstelle das relevante API-Schlüsselpaar aus HR WORKS. Hierzu benötigen Sie die Administratoren-Rolle "API-Administrator". Wie diese vergeben wird, erfahren Sie hier.

Begeben Sie sich zunächst in das Admin-Menü "Grundlagen/Integrationen/HR WORKS-API/Reiter 'Schlüsselpaare'". Bevor Sie den Button "Neues Schlüsselpaar" betätigen, wählen Sie bitte im Drop-down Menü die Vorlage "Default" aus.

2025-11-26 09_17_00-UI_UX-Anpassung im Helpcenter

Nach Erstellung erscheint ein Pop-Up, welches das Schlüsselpaar kurz beschreibt und eine Möglichkeit zum Download dieses anbietet. Laden Sie die Textdatei, welche den Access Key sowie Secret Access Key enthält, herunter.

48

 

Im Menü "Grundlagen/Integrationen/HR WORKS-API/Reiter 'Schlüsselpaar-Vorlagen'" haben Sie die Möglichkeit, eigene editierbare Schlüsselpaar-Vorlagen über den Button "Neue Vorlage" zu erstellen.


Innerhalb einer selbst erstellten Vorlage haben Sie die Möglichkeit, festzulegen, welche Endpoints über die API ausgelesen und zu welchen Endpoints Daten über die API geschrieben werden können.

2025-11-26 09_31_24-Greenshot


Des Weiteren haben Sie die Möglichkeit einzustellen, ob die Berechtigungen und der Stammdatenzugriff innerhalb des Schlüsselpaares bearbeitbar sein sollen.

2025-11-26 09_34_06-Customer Service - 3CX

2025-11-26 09_34_31-Greenshot

Hinweis: Bitte beachten Sie hierbei, dass sobald ein Schlüsselpaar mit den vorgenommenen Einstellungen der Vorlage angelegt worden ist, diese Einstellungen innerhalb des Schlüsselpaars nicht mehr angepasst werden können - hierfür muss ein neues Schlüsselpaar angelegt werden, nachdem die Vorlage entsprechend geändert wurde.