Versionierte REST-Endpunkte
Die produktiven Schnittstellen liegen unter /api/v1. Requests und Antworten verwenden für die regulären API-Endpunkte JSON.
API & Integrationen
ZeitDesk lässt sich auch direkt per REST-API anbinden.
Neben Web-, Desktop- und Mobile-Clients stellt ZeitDesk eine umfangreiche, versionierte REST-API bereit. Unternehmen können damit eigene Anwendungen, interne Prozesse und Automatisierungen an ihren ZeitDesk-Unternehmensbereich anbinden.
Technische Grundlage
Eine Schnittstelle, dieselben Regeln.
Die API arbeitet auf demselben ZeitDesk-SaaS wie die Benutzeroberflächen. Berechtigungen, Mandantentrennung und fachliche Prüfungen werden deshalb serverseitig genauso durchgesetzt wie bei der Nutzung über die ZeitDesk-Clients.
Eigener Unternehmensbereich
Jeder Kunde greift über seinen eigenen ZeitDesk-Unternehmensbereich auf die API zu, zum Beispiel überhttps://<firmenkuerzel>.zeitdesk.app/api/v1/....
Authentifiziert und berechtigungsbasiert
API-Zugriffe erfolgen authentifiziert. Für App- und Integrationszugriffe unterstützt ZeitDesk Bearer-Tokens. Aktionen bleiben an die Berechtigungen des angemeldeten Benutzers gebunden.
Keine zweite Datenwelt
Die API greift auf dieselben fachlichen Dienste wie die ZeitDesk-Oberflächen zu. Dadurch gelten dieselben Regeln für Zeitbuchungen, Korrekturen, Berechtigungen und Auswertungen.
Funktionsumfang
Wichtige ZeitDesk-Funktionen sind auch per API erreichbar.
Zeiterfassung
Einstempeln, Pausen starten und beenden, ausstempeln, aktuellen Status abfragen und native Offline-Buchungen synchronisieren.
Mitarbeiter & Benutzer
Benutzer lesen und anlegen, Daten ändern sowie Konten sperren, entsperren, archivieren oder reaktivieren.
Gruppen & Berechtigungen
Gruppen verwalten und deren Berechtigungen über die API gezielt setzen.
Korrekturen & Historie
Korrekturanfragen erstellen und bearbeiten sowie die Historie von Zeitereignissen nachvollziehen.
Reporting & Exporte
Arbeitszeiten auswerten und die vorgesehenen Berichte als strukturierte Daten sowie als CSV- oder PDF-Ausgabe abrufen.
Terminals & Einstellungen
Terminals verwalten und ausgewählte Einstellungen des Unternehmensbereichs über abgesicherte Endpunkte bearbeiten.
Beispiel
Ein normaler authentifizierter API-Aufruf.
Nach erfolgreicher Authentifizierung wird das Access-Token imAuthorization-Header übertragen.
GET https://ihrefirma.zeitdesk.app/api/v1/me
Authorization: Bearer <access_token>
Accept: application/jsonErfolgreiche JSON-Antworten verwenden ein einheitliches Format mitsuccess und data. Fehler liefern einen strukturierten Fehlercode und eine Nachricht.
Sicherheit
Die Schnittstelle umgeht keine ZeitDesk-Regeln.
- API-Zugriffe bleiben auf den jeweiligen Unternehmensbereich begrenzt.
- Berechtigungen werden serverseitig geprüft.
- Access- und Refresh-Tokens können erneuert und widerrufen werden.
- Gesperrte oder nicht mehr aktive Benutzer verlieren den regulären Zugriff.
- Fachliche Validierungen gelten auch für API-Aufrufe.
Eigene Integration
ZeitDesk mit Ihren bestehenden Systemen verbinden.
Sie möchten ZeitDesk aus einer eigenen Anwendung ansprechen oder Daten in einen bestehenden Unternehmensprozess übernehmen? Wir unterstützen Sie bei der Auswahl der passenden API-Endpunkte und Berechtigungen.