WorkLogx Public API
Mit der WorkLogx Public API greifen Ihre Systeme programmatisch auf die Daten Ihrer WorkLogx-Organisation zu: Mitarbeitende, Kunden, Projekte, Aufgaben, Formulare, Einreichungen, Abwesenheiten und Arbeitszeiten. Typische Einsätze sind der Abgleich von Stammdaten aus ERP oder CRM und der Export erfasster Arbeit in Lohnabrechnung oder Fakturierung.
#Auf einen Blick
| Basis-URL | TEST https://api-test.worklogx.com/api, Produktion https://api.worklogx.com/api |
| Version | v1, alle Pfade beginnen mit /v1/ |
| Format | JSON über HTTPS |
| Authentifizierung | API Key als Bearer-Token |
| Pagination | Opaker Cursor, limit Standard 50, maximal 100 |
| Schreibzugriffe | POST benötigt den Header Idempotency-Key |
#Ressourcen in V1
| Ressource | Lesen | Anlegen / Ändern |
|---|---|---|
| Employees | GET /v1/employees, GET /v1/employees/{id} | POST, PATCH |
| Customers | GET /v1/customers, GET /v1/customers/{id} | POST, PATCH |
| Projects | GET /v1/projects, GET /v1/projects/{id} | POST, PATCH |
| Tasks | GET /v1/tasks, GET /v1/tasks/{id} | POST, PATCH |
| Absences | GET /v1/absences, GET /v1/absences/{id} | POST, PATCH |
| Forms | GET /v1/forms, GET /v1/forms/{id} | nur lesen |
| Submissions | GET /v1/submissions, GET /v1/submissions/{id} | nur lesen |
| Worklogs | GET /v1/worklogs, GET /v1/worklogs/{id} | nur lesen |
Jede Anfrage gilt nur für die Organisation, der der API Key gehört. Jede Operation benötigt einen Scope wie customers:read oder customers:write; die API-Referenz nennt den Scope pro Endpunkt.
#Authentifizierung
Senden Sie Ihren API Key im Header Authorization:
Authorization: Bearer wlx_test_<prefix>_<secret>Keys mit wlx_test_ gehören zur Testumgebung, Keys mit wlx_live_ zur Produktion. Jede Umgebung akzeptiert nur ihre eigenen Keys. Halten Sie Keys geheim und verwenden Sie sie nur serverseitig. Details: Authentifizierung.
#Nächste Schritte
- Erste Schritte: API Client anlegen und die erste Anfrage senden.
- API-Referenz: alle V1-Endpunkte mit Parametern, Schemas und Beispielen.