API-Dokumentation

Verbinden und Arbeiten mit der Shifton-API

Die Shifton-API bietet Ihnen Zugriff auf alle wichtigen Funktionen der Plattform – von der Zeitplanverwaltung bis hin zu Integrationen mit externen HR, -Lohnabrechnung– und Analysesystemen.
Durch die Nutzung der API können Sie Prozesse automatisieren und Shifton mit den internen Diensten Ihres Unternehmens verbinden.


API-Dokumentation

Wir unterstützen zwei Versionen unserer Dokumentation:


Erste Schritte

API-Schlüssel erhalten

Generieren Sie in den Unternehmenseinstellungen auf der Shifton-Plattform einen API-Schlüssel.
Die Autorisierung erfolgt über den Header:

Authorization: Bearer {your_api_key}

Ihre erste Anfrage stellen

Um beispielsweise eine Liste der Mitarbeiter abzurufen:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

Beispielantwort:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

Integrieren Sie die API in Ihre Arbeitsabläufe

  • Automatisches Erstellen und Ändern von Schichten

  • Verwalten von Urlaubs- und Krankheitsanträgen

  • Exportieren von Daten in Lohnabrechnungssysteme

  • Erstellen von benutzerdefinierten Dashboards und Berichten


Kern-API-Fähigkeiten

  • Mitarbeiter – hinzufügen, bearbeiten und Rollen verwalten

  • Zeitpläne – Schichten erstellen, anpassen, Arbeit planen

  • Freizeit und Abwesenheiten – Urlaubs- und Krankheitsanfragen verwalten

  • Berichterstattung – Zeit-, Lohn- und Anwesenheitsdaten exportieren


Fehlermeldungen

Die Shifton-API verwendet StandardHTTP-Statuscodes:

  • 200 — Erfolgreiche Anfrage

  • 201 — Objekt erfolgreich erstellt

  • 400 — Ungültige Parameter

  • 401 — Autorisierungsfehler (ungültiger API-Schlüssel)

  • 403 — Zugriff verweigert

  • 404 — Ressource nicht gefunden

  • 500 — Serverfehler


Nutzungstipps

  • Verwenden Sie immer dieneue API-Version für neue Integrationen

  • Verwenden Sie Postman oder curl zum Testen

  • Respektieren Sie Ratenlimits um nicht blockiert zu werden

  • Aktualisieren Sie Integrationen, die noch auf die alte Dokumentation angewiesen sind


Diesen Beitrag teilen