TimeMeDeveloper / Unternehmens-APIStatus wird geladen …OpenAPI herunterladen ↓

TIMEME FÜR IHRE SYSTEME

Ihre Arbeitszeiten.
Ihre Integration.

Verbinden Sie Personalverwaltung, Zeiterfassung und Dienstplanung mit Ihren eigenen Anwendungen. Ein Zugang pro Integration, genau die Berechtigungen, die Sie benötigen.

– Endpunktev1 stabile API-PfadeHTTPS verschlüsselte Übertragung
BASE URLhttps://api.timeme.st-braun.de/v1
01

IN WENIGEN SCHRITTEN

Zugang & Authentifizierung

  1. API freischalten lassen. Admin SJB aktiviert die API zentral und für Ihr Unternehmen.
  2. Integration anlegen. Im Manager unter „Unternehmens-API“ Name, Ablaufdatum und einzelne Berechtigungen festlegen. Client-ID und das einmalig angezeigte Secret sicher speichern.
  3. Token beziehen. Client-ID und Secret als JSON oder HTTP Basic an POST /v1/auth/token senden. Das Token ist 15 Minuten gültig.
  4. Daten abrufen. Authorization: Bearer TOKEN mitschicken. Nach Ablauf ein neues Token beziehen. Rotation, Widerruf und Freigabeänderungen beenden bestehende Tokens sofort.
curl -X POST 'https://api.timeme.st-braun.de/v1/auth/token' \
  -H 'Content-Type: application/json' \
  -d '{"clientId":"IHR_API_KEY","clientSecret":"IHR_SECRET"}'

curl 'https://api.timeme.st-braun.de/v1/locations' \
  -H 'Authorization: Bearer IHR_TOKEN'
Testkonsole verbinden

Optional: Melden Sie Ihre eigene Integration an, um Endpunkte direkt auszuprobieren. Die Konsole arbeitet mit echten Unternehmensdaten. Zugangsdaten und Token bleiben nur im Arbeitsspeicher dieses Tabs. Das Secret-Feld wird nach der Anmeldung geleert.

Nicht verbunden

02

GUT ZU WISSEN

Einheitliche Regeln

Nur Ihr Unternehmen

Die Client-ID bestimmt den Mandanten. Keine tenantId mitsenden. Fremde Datensatz-IDs sind nicht zugänglich. RFID-UIDs und Standortleitungsrechte werden nicht ausgegeben.

Gezielte Berechtigungen

Jeder Endpunkt zeigt seine benötigte Berechtigung. Tokens berechtigen ausschließlich diese API. Schichtplanung muss separat freigeschaltet sein. Schreibrechte sind bewusst einzeln zu vergeben.

Listen & Zeiträume

Bei gekennzeichneten Listen: limit=100 (max. 200), offset=0. meta.nextOffset ist bei der letzten Seite null. Zeiträume sind einschließlich from/to, höchstens 366 Tage; Abrechnung höchstens 45 Tage. Datumswerte gelten in der Mandantenzeitzone, Zeitpunkte brauchen einen UTC-Offset.

Schreiben ohne Duplikate

JSON-Schreibanfragen unterstützen optional Idempotency-Key (8–128 Zeichen, 24 Stunden). Wiederholen Sie dieselbe Anfrage mit demselben Key. Andere Nutzlast ergibt 409. Bei 409 mit idempotency_pending läuft die Anfrage noch oder wurde unterbrochen: Datensatz zuerst prüfen; die Kennung bleibt gesperrt. Datei-Downloads unterstützen keinen Idempotency-Key. Pläne benötigen außerdem die aktuelle revision.

Limits & Wiederholung

120 Anfragen pro Minute je Key, zusätzlich 600 je IP; Token-Anmeldung 10 Versuche pro Minute je IP. Bei 429 den Header Retry-After beachten. JSON höchstens 128 KiB. Unbekannte Eingabefelder werden abgewiesen.

Produktiv verbinden

Secrets gehören in Ihren Server oder Secret-Speicher. Keine fremden Browser-Ursprünge (CORS). In der Konsole bestätigen Sie jede schreibende Anfrage. Auto-Plan kann Kosten auslösen; Planfreigabe kann E-Mails versenden.

Antworten

{"data": {"id": 1, "name": "Zentrale"}, "requestId": "…"}
{"data": [], "meta": {"total": 0, "limit": 100, "offset": 0, "nextOffset": null}, "requestId": "…"}
{"error": {"code": "insufficient_scope", "message": "Berechtigung fehlt."}, "requestId": "…"}

Datei-Endpunkte liefern CSV bzw. PDF direkt. Übergeben Sie bei Rückfragen die Request-ID aus Antwort oder X-Request-Id. Die letzten 100 Vorgänge sind im Manager sichtbar; Aufrufprotokolle werden 90 Tage aufbewahrt. Inhalte, Secrets und Tokens werden dort nicht protokolliert.

StatusBedeutungNächster Schritt
400 / 413Ungültige oder zu große AnfrageParameter, Schema und Größenlimit prüfen
401Token/Key ungültig oder abgelaufenToken neu beziehen; Widerruf und Rotation prüfen
403Berechtigung oder Unternehmensfreigabe fehltIm Manager / bei Admin SJB prüfen
404Datensatz/Endpunkt nicht gefundenEigene ID und API-Pfad prüfen
409Fachlicher Konflikt / veraltete RevisionDaten erneut laden und Konflikt beheben
429Zu viele AnfragenRetry-After abwarten
500 / 503Serverfehler / zentrale API-SperreSpäter versuchen / Freigabe prüfen
03

DIE SCHNITTSTELLE IM DETAIL

Endpunkte entdecken

Öffnen Sie einen Endpunkt für Parameter, Anfragebeispiele und Testkonsole. Zusätzlich: GET /v1/status liefert den öffentlichen Betriebsstatus ohne Anmeldung. POST /v1/auth/token ist oben beschrieben.

API-Katalog wird geladen …