🔌

API-Zugang

Erzeuge API-Schlüssel, um deine ShiftScan-Daten direkt über die REST-API zu lesen und (mit Schreibzugriff) zu bearbeiten — z. B. für eigene Auswertungen oder die Anbindung anderer Systeme. Der API-Zugang ist Teil des Business-Plans.

Wofür ist diese Seite?

Auf „API-Zugang" erstellst du API-Schlüssel (Keys), mit denen externe Programme oder Skripte auf deine ShiftScan-Daten zugreifen können — über eine standardisierte REST-API. Du steuerst je Key, ob er nur lesen oder auch schreiben darf, und kannst Keys jederzeit widerrufen. Jeder Key ist auf 60 Anfragen pro Minute begrenzt. Der API-Zugang ist ein Business-Feature.

API-Zugang: Key erstellen und die Endpunkte der REST-API.

In 30 Sekunden

•Key-Namen vergeben (z. B. „Lohnbuchhaltung") und optional „Schreibzugriff" anhaken.
•„Key erstellen" — der Schlüssel wird EINMALIG angezeigt: sofort kopieren.
•Im Code als Header senden: Authorization: Bearer ssk_…
•Nicht mehr genutzte Keys über „Widerrufen" deaktivieren.

Schritt für Schritt

1
Öffne „Einstellungen" → „API". Trage unten einen sprechenden Key-Namen ein (z. B. „Lohnbuchhaltung" oder „Reporting"), damit du später weißt, wofür der Key ist.

Key erstellen und die API-Dokumentation mit allen Endpunkten.
2
Soll der Key auch Daten ändern dürfen (z. B. Mitarbeiter anlegen), hake „Schreibzugriff" an. Für reine Auswertungen lass es aus — „Nur Lesen" ist sicherer.
3
Klick „Key erstellen". Der Schlüssel (beginnt mit ssk_…) wird NUR EINMAL angezeigt — kopiere ihn sofort und bewahre ihn sicher auf. Danach siehst du nur noch den Anfang (Prefix).
4
Verwende den Key in deinen Anfragen als Header „Authorization: Bearer ssk_…" gegen die Basis-URL aus der „API-Dokumentation". Nicht mehr benötigte Keys widerrufst du in der Liste.

Feld für Feld

Key-Name: Frei wählbarer Name zur Wiedererkennung (z. B. „Lohnbuchhaltung"). Pflichtfeld.
Schreibzugriff: Angehakt = der Key darf Daten lesen UND schreiben; sonst nur lesen. Im Zweifel weglassen.
Key erstellen: Erzeugt den Schlüssel. Er wird aus Sicherheitsgründen nur einmal vollständig angezeigt.
Schlüssel-Liste: Zeigt je Key Name, Prefix, Umfang (Nur Lesen / Lesen & Schreiben) und letzte Nutzung; „Widerrufen" deaktiviert ihn sofort.
API-Dokumentation: Aufklappbar: Basis-URL, der Authorization-Header und die verfügbaren Endpunkte (z. B. /v1/employees, /v1/shifts, /v1/time-entries).

Tipp

💡

Lege je Anwendungszweck einen eigenen Key an (z. B. einen für Reporting, einen fürs Lohnbüro). So kannst du einen einzelnen Key widerrufen, wenn er nicht mehr gebraucht wird oder kompromittiert ist — ohne die anderen Integrationen zu stören.

Stolperfalle

⚠️

Der vollständige Schlüssel wird NUR EINMAL direkt nach dem Erstellen angezeigt — danach nie wieder. Kopierst du ihn nicht sofort, musst du einen neuen Key erstellen. Gib Keys niemals öffentlich weiter (kein Commit in Code-Repos). Und beachte das Limit von 60 Anfragen pro Minute je Key.

Häufige Fragen

Ich habe den Key nicht kopiert — wie komme ich wieder dran?

Gar nicht. Aus Sicherheitsgründen wird der vollständige Schlüssel nur einmal angezeigt. Erstelle einfach einen neuen Key und widerrufe den alten.

Was bedeutet „Schreibzugriff"?

Ohne Schreibzugriff kann der Key Daten nur lesen (GET-Endpunkte). Mit Schreibzugriff darf er auch Daten anlegen oder ändern (z. B. POST /v1/employees). Vergib ihn nur, wenn die Anwendung wirklich schreiben muss.

Welche Daten kann ich über die API abrufen?

Unter anderem Mitarbeiter, Objekte, Projekte, Kunden, Schichten, Zeitbuchungen und Abwesenheiten. Die vollständige Liste der Endpunkte findest du unter „API-Dokumentation" auf der Seite.