In folgendem Artikel erhalten Sie einen Kurzüberblick über Daten in HRworks auf die Sie via API zugreifen können.
Inhaltsverzeichnis
1. Lernvideo
Schauen Sie hier das Video zum Artikel:
2. HRworks API-Update als E-Mail empfangen
3. API Dokumentation
4. Einführung
Die öffentliche HRworks-API v2 bietet Ihnen die Möglichkeit mit externen Applikationen auf Daten in HRworks 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.
Personenstammdaten
Lassen Sie sich über die API die aktuellen Stammdaten Ihrer Mitarbeiter ausgeben, beispielsweise zur Synchronisation mit anderen Systemen. Ebenso haben Sie die Möglichkeit, in HRworks neue Personen anzulegen und bestehende Stammdaten zu aktualisieren, indem Sie aus Fremdsystemen exportierte Daten über die API in HRworks importieren.
Daten zu Abwesenheiten
Lassen Sie sich Detailinformationen zu den Abwesenheiten und Krankmeldungen Ihrer Mitarbeiter ausgeben. Auch hier haben Sie die Möglichkeit, aus Fremdsystemen exportierte Mitarbeiterdaten zu Abwesenheiten und Krankheiten über die API in HRworks zu importieren, um sie in der HR-Software zu erfassen.
Urlaubskonto
Rufen Sie über die API den Urlaubskontostand ihrer Mitarbeiter ab.
Aktive und derzeit anwesende Mitarbeiter
Nutzen Sie die API, um sich alle aktiven Personen Ihres Unternehmens oder alle heute anwesenden Personen einer Organisationseinheit ausgeben zu lassen.
Arbeitszeiten
Neben den einzelnen Arbeitszeiten, fragen Sie über die API die Soll- und Ist-Arbeitsstunden, sowie Pausenzeiten Ihrer Mitarbeiter in einem bestimmten Zeitraum ab, beispielsweise zur Kapazitäts- und Personalplanung. Ebenso erhalten Sie die konfigurierten Zeiterfassungsarten. Wollen Sie die Arbeitszeiten von Mitarbeitern selbst erfassen, können diese neu erstellt und ebenfalls in HRworks übertragen werden.
Terminals und Kiosksysteme
Wenn Sie nicht HRworks als Kiosksystem verwenden, dann haben Sie über die API dennoch die Option, das Ein- und Ausstempeln Ihrer Mitarbeiter in HRworks zu erfassen. Via API übermitteln Sie diese Daten und erhalten darüber hinaus den aktuellen Status der jeweiligen Mitarbeiter.
Reisedaten
Die HRworks API v2 verfügt nun über erste lesende Zugriffe, mit denen Sie sich eine Auflistung von Reisekostenabrechnungen und Reiseanträge für ausgewählte Personen,
Zeiträume und in entsprechendem Status aufrufen können. Der Bereich Reisemanagement
wird zukünftig durch weitere Endpunkte erweitert.
Bewerbermanagement
Mit der API v2 können Stellenanzeigen aus HRworks ausgelesen werden. Somit ist es möglich ein eigenes, individuelles Stellenportal aufzubauen, das sich nahtlos in das Design der Firmen-Webseite einpassen lässt. Zusätzlich besteht die Möglichkeit, Bewerbungen zu erstellen und auszulesen, sodass Bewerberformulare innerhalb von Stellenportalen ebenfalls individuell gestaltet werden können.
Onboarding
Über den lesenden Aufruf der API im Bereich des Onboarding, können Sie die hinterlegten Stammdaten sowie Dokumente zu einem Eintrag einsehen. Es ist außerdem möglich neue Onboarding Einträge über die API zu erstellen und hierbei Dateien als URL oder direkt im Request-Body zu übermitteln.
Hinweis: Es kann ein Schlüsselpaar via Vorlagen erstellt werden, dass für die Integration der Bewerbermanagement-Software Softgarden genutzt werden kann. Genaue Details zum Einrichten der Schnittstelle erhalten Sie von Ihrem Softgarden-Ansprechpartner oder im dazugehörigen Helpcenter-Artikel.
Personalakte
Lesen Sie Personalaktenkategorien sowie Personalakteneinträge über die API aus. Hierbei können einzelne Einträge oder die gesamte Personalakte einer Person übertragen werden.
Zudem können Sie über den schreibenden Endpunkt Personalakteneinträge erstellen und Dateien anhängen.
5. API Schlüsselpaar
Sofern Sie die Einrichtung abgeschlossen haben, benötigen Sie zur Nutzung der Schnittstelle das relevante API-Schlüsselpaar aus HRworks. 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/HRworks-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.
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.
