API-Keys für externe Systeme erstellen

API-Keys für externe Systeme erstellen

Mit API-Keys können externe Systeme — etwa Ihr Kassensystem, ein BI-Tool oder ein eigenes Skript — auf Shiftdesk-Daten zugreifen. Jeder Key bekommt genau definierte Scopes, sodass Sie den Zugriff so eng wie möglich halten können.

Neuen API-Key erstellen

1. Gehen Sie zu Einstellungen → API-Keys.
2. Klicken Sie auf Neuer API-Key.
3. Vergeben Sie einen Namen (z. B. "Kasse Filiale Köln").
4. Wählen Sie die benötigten Scopes:
   • employees:read — Mitarbeiterdaten lesen
   • shifts:read / shifts:write — Schichten lesen/schreiben
   • time-entries:read — Stempelungen lesen
   • absences:read — Abwesenheiten lesen
5. Klicken Sie auf Erstellen.

Wichtig: Einmalige Anzeige

Der vollständige Key (sk_live_...) wird nur einmal angezeigt — direkt nach der Erstellung. Kopieren Sie ihn sofort in einen sicheren Passwort-Manager. Danach sehen Sie im Dashboard nur noch die letzten 4 Zeichen zur Identifikation.

Wenn Sie den Key verlieren, müssen Sie einen neuen erstellen — Shiftdesk kann ihn nicht wiederherstellen.

Beispiel-Request

Die API-Base-URL lautet https://api.shiftdesk.app/v1. Authentifizierung erfolgt über den Authorization-Header:

curl -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
     -H "Content-Type: application/json" \
     https://api.shiftdesk.app/v1/employees

Rotation und Widerruf

Aus Sicherheitsgründen sollten Sie API-Keys mindestens jährlich rotieren:

1. Erstellen Sie einen neuen Key mit identischen Scopes.
2. Hinterlegen Sie ihn im Zielsystem.
3. Prüfen Sie, dass alles funktioniert.
4. Widerrufen Sie den alten Key über das Mülleimer-Symbol in der Liste.

Widerrufene Keys werden sofort ungültig — laufende Requests schlagen mit 401 Unauthorized fehl.

Audit-Log

Jeder API-Zugriff wird mit Zeitstempel, IP und Endpoint im Audit-Log protokolliert. Sie finden die Logs unter Einstellungen → Sicherheit → API-Aktivität.

Rate-Limits

Shiftdesk drosselt pro Key auf 120 Requests/Minute. Brauchen Sie mehr, melden Sie sich beim Support.