Produktive Basis-URL
https://api.jobhandy.io/v1Authentifizierung
X-API-Key bei jeder geschützten AnfrageAnfragekorrelation
UUID v4 oder v7 in
X-Request-IDAPI-Key erstellen
Erstellen Sie im JobHandy-Administrationsbereich einen Key mit passendem Scope.
Quickstart beginnen
Prüfen Sie Erreichbarkeit und Authentifizierung, lesen Sie Mitarbeiter und validieren Sie einen Schreibvorgang.
API-Referenz öffnen
Prüfen Sie alle Operationen, Parameter, Antworten, Schemas und Fehlerfälle.
OpenAPI herunterladen
Verwenden Sie den maßgeblichen OpenAPI-3.1-Vertrag im JSON- oder YAML-Format.
Integrationskontext
Die Kundenintegration ist für Zeitplanung, Mapping, Retry-Steuerung, Checkpoints, sichere Secret-Speicherung und nachgelagerte Verarbeitung verantwortlich. JobHandy validiert die Anfrage, erzwingt den Scope des API-Keys, wendet die dokumentierten Statusregeln an und gibt zur Korrelation eine Request-ID zurück.Was Sie integrieren können
Mitarbeitersynchronisation
Mitarbeiter anlegen, unterstützte Felder aktualisieren, Divisionen zuweisen und Konten sperren oder entsperren.
HR-Prüfung von Bestellungen
Zu prüfende Bestellungen abrufen und eine Freigabe- oder Ablehnungsentscheidung übermitteln.
Vorfallsmeldungen
Mitarbeitervorfälle anlegen und aktualisieren sowie zulässige Nachweisdokumente hochladen.
Organisationsstruktur
Tenant-eigene Divisionshierarchien und Kostenstellen erstellen und pflegen.
Payroll-Abruf
Metadaten zu Payroll-Exporten ermitteln und verfügbare Dateien herunterladen.
Betriebsüberwachung
Die grundlegende Verfügbarkeit der Public API ohne API-Key prüfen.
Grundregeln
Ausschließlich produktiver Endpoint
Ausschließlich produktiver Endpoint
Öffentliche Integrationen verwenden
https://api.jobhandy.io/v1. Interne Entwicklungs- oder Stage-Hosts sind nicht Bestandteil des öffentlichen Vertrags.Zugriff nach dem Least-Privilege-Prinzip
Zugriff nach dem Least-Privilege-Prinzip
Ein API-Key kann ausschließlich auf die in seinem Scope ausgewählten Tenants und Divisionen zugreifen.
X-Tenant-ID kann diesen Scope einschränken, aber niemals erweitern.Dry Run ist keine Sandbox
Dry Run ist keine Sandbox
Unterstützte Schreiboperationen akzeptieren
dryRun=true. Die Anfrage wird gegen den aktuellen produktiven Scope und Zustand validiert; die dokumentierte Änderung und ihre Side Effects werden jedoch nicht ausgeführt.Unbekannte Felder werden abgelehnt
Unbekannte Felder werden abgelehnt
Request-Schemas sind geschlossen. Senden Sie ausschließlich dokumentierte Eigenschaften und Medientypen.
Request-IDs sind keine Idempotency Keys
Request-IDs sind keine Idempotency Keys
X-Request-ID korreliert Anfragen und Antworten. Der Header dedupliziert keine Schreibvorgänge und macht einen Retry nicht automatisch sicher.Ressourcenmodell
Weitere Informationen zu Eigentümerschaft, Beziehungen und Begriffen finden Sie unter Architektur und Ressourcenmodell.Empfohlener Weg in den produktiven Betrieb
1
Dedizierten API-Key erstellen
Wählen Sie nur die Unternehmen und Divisionen aus, die die Integration tatsächlich benötigt.
2
Quickstart vollständig durchführen
Prüfen Sie Health, Authentifizierung, Tenant-Auswahl, Request-IDs und Dry-Run-Validierung.
3
Passenden Integrationsleitfaden umsetzen
Folgen Sie dem Ablauf für Mitarbeiter, Bestellungen, Vorfälle, Divisionen oder Payroll-Exporte.
4
Go-live-Checkliste abschließen
Prüfen Sie Secret-Speicherung, Retries, Reconciliation, Monitoring und Supportbereitschaft.
Go-live-Checkliste prüfen
Stellen Sie vor der Aktivierung produktiver Zeitpläne sicher, dass die Integration sicher betrieben werden kann.