Verbindungsdaten
Ressourcen
Mitarbeiter
Stammdaten, Kontosperrung, Tenant-Zuordnung und Divisionszuweisung.
Bestellungen
Abruf, HR-Freigabeentscheidungen, Produkte, Vertragsdaten und Dokumente.
Vorfälle
Meldung, serververwalteter Lifecycle-Status, unterstützte Updates und Nachweisdateien.
Divisionen
Tenant-eigene Hierarchie, Reihenfolge unter Geschwistern, Parent-Beziehungen und Kostenstellen.
Payroll-Exporte
Schreibgeschützte Dokumentmetadaten und Downloads verfügbarer Dateien.
Health
Öffentlicher Endpoint zur grundlegenden Verfügbarkeitsprüfung.
Operationsmatrix
Einheitliches Verhalten
Authentifizierung und Scope
Authentifizierung und Scope
Geschützte Anfragen erfordern
X-API-Key. Die API erzwingt den Tenant- und Divisionsscope des Keys für jede Ressource und Referenz.Optionale Parameter
Optionale Parameter
Optionale Query- und Headerparameter sind in der Referenz sichtbar, werden aber erst nach Auswahl in generierte Requests übernommen.
Dry Runs
Dry Runs
Unterstützte Schreibvorgänge akzeptieren
dryRun=true und geben die dokumentierte Projektion zurück, ohne Speicherung oder Side Effects anzuwenden.Fehler
Fehler
Fehler verwenden
{ "error": { "code", "message", "requestId" } }. Die Response-Liste der jeweiligen Operation ist maßgeblich.Retries
Retries
Reads können innerhalb begrenzter Richtlinien wiederholt werden. Writes erfordern nach Timeouts oder Konflikten eine Reconciliation des aktuellen Zustands.
Vor der Verwendung einer Operation
- Prüfen Sie, ob der API-Key den erforderlichen Scope enthält.
- Ermitteln Sie, ob
X-Tenant-IDerforderlich ist. - Prüfen Sie Side Effects und Dry-Run-Unterstützung.
- Erzeugen und protokollieren Sie
X-Request-ID. - Behandeln Sie jeden dokumentierten Response-Status.
- Definieren Sie die Reconciliation, bevor Sie einen Write wiederholen.
Fehlerbehandlung
Ordnen Sie HTTP-Status, API-Fehlercode, Korrekturmaßnahme und Retrybarkeit zu.
OpenAPI-Spezifikation
Laden Sie den vollständigen maschinenlesbaren Vertrag herunter.