Zum Hauptinhalt springen
Zu den Integrationen ↗ · Öffnet die Webapp — bitte vorher anmelden Über die REST API sendest du deine aktiven Mitarbeitenden an Honestly. Sie laufen durch dieselbe Import-Engine wie jede andere Mitarbeiterquelle — die REST API ist also die programmierbare Alternative zum CSV-Import über SFTP. Statt eine Datei hochzuladen, überträgt dein HR-System die Mitarbeitenden direkt, sobald sich etwas ändert. Dieser Artikel richtet sich an HR-Admins und deren IT, die den Import einrichten. Die vollständige technische Beschreibung der Schnittstelle findest du in der API-Dokumentation. Nur Admins können die Integrationsseite sehen und verwalten.

​
Integration verbinden

  1. Gehe zu Einstellungen → Integrationen und öffne die Kachel REST API.
  2. Klicke auf Verbinden. Honestly erzeugt einen API-Schlüssel.
  3. Kopiere ihn mit Schlüssel kopieren und hinterlege ihn in dem System, das deine HR-Daten überträgt. Bestätige anschließend mit Ich habe den Schlüssel kopiert.
Der API-Schlüssel wird nur ein einziges Mal angezeigt. Geht er verloren, öffne die Kachel über Bearbeiten und erzeuge mit Schlüssel erneuern einen neuen. Der alte Schlüssel wird dabei sofort ungültig.
Im selben Dialog stehen der Endpunkt und der Hinweis, dass die Authentifizierung über den Header X-Api-Key läuft. Der Schlüssel aus dieser Integration darf ausschließlich Mitarbeitende schreiben und kann keine Daten über die Export-API lesen. Umgekehrt funktionieren die auf der Seite für API-Schlüssel erzeugten Lese-Schlüssel hier nicht.

​
Wie der Import funktioniert

Jede Anfrage überträgt die vollständige Liste deiner aktiven Mitarbeitenden — eine Momentaufnahme, kein Zusatz zum Bestand. Daraus folgt:
  • Mitarbeitende, die du sendest, werden angelegt oder aktualisiert.
  • Mitarbeitende, die du nicht mehr sendest, werden geoffboardet, also aus dem aktiven Bestand entfernt — allerdings nur solche, die über die REST API angelegt wurden.
Manuell, per Excel, per SFTP-CSV oder über einen HCM-Konnektor angelegte Mitarbeitende bleiben von diesem Import unberührt. In der Spalte Quelle der Mitarbeiterliste erkennst du die Herkunft jedes Eintrags; mehr dazu in Importquelle prüfen.

​
Die Löschschwelle

Damit eine fehlerhafte Übertragung nicht versehentlich einen Großteil deiner Belegschaft entfernt, gibt es im Verbinden-Dialog die Löschschwelle. Ein Import, der mehr als diesen Anteil der über die REST API importierten Mitarbeitenden löschen würde, wird vollständig abgebrochen und ändert nichts. Voreingestellt sind 20 %; du kannst den Wert im Dialog anpassen.
Erhöhe die Löschschwelle nur für einen geplanten Massenaustritt und setze sie danach wieder zurück. Bei einem sehr hohen Wert schützt dich fast nichts mehr: Eine fehlerhafte Anfrage kann dann deine gesamte Belegschaft offboarden.

​
REST API oder CSV/SFTP?

Beide Wege führen durch dieselbe Import-Engine und folgen demselben Momentaufnahme-Prinzip. Der Unterschied liegt in der Übertragung:
  • REST API — dein HR-System sendet die Mitarbeitenden direkt, sobald sich etwas ändert.
  • CSV über SFTP — du legst eine Datei ab, die zu festen Zeiten eingelesen wird. Siehe CSV-Import (SFTP).
Es kann immer nur eine Mitarbeiterquelle gleichzeitig aktiv sein. Solange eine andere Anbindung — CSV/SFTP oder ein HCM-Konnektor — verbunden ist, lässt sich die Kachel REST API nicht verbinden. Trenne zuerst die bestehende Anbindung. Für SAP SuccessFactors gibt es keinen Direktkonnektor. Die Anbindung läuft daher entweder über CSV/SFTP oder über die REST API.

​
Verwandte Artikel