Erste Schritte

In wenigen Minuten zur ersten Anfrage an die WorkLogx Public API. Alle Beispiele verwenden die TEST-Umgebung (https://api-test.worklogx.com/api) mit einem wlx_test_-Key. Die Produktion nutzt https://api.worklogx.com/api mit wlx_live_-Keys, siehe Authentifizierung.

#1. WorkLogx öffnen

Melden Sie sich in der WorkLogx Web-App mit einem Konto an, das Integrationen verwalten darf.

#2. Integrationen öffnen

Öffnen Sie Integrationen in der Navigation.

#3. WorkLogx API wählen

Wählen Sie WorkLogx API.

#4. API Client erstellen

Klicken Sie auf API-Zugang erstellen und benennen Sie ihn nach der Integration, zum Beispiel „ERP-Sync“.

#5. Scopes auswählen

Wählen Sie unter Berechtigungen nur, was die Integration benötigt. Lesen erfolgt über <resource>:read, Anlegen und Ändern über <resource>:write, zum Beispiel customers:read. Siehe API Keys & Scopes.

#6. API Key einmalig kopieren

Der API Key wird nur einmal angezeigt. Kopieren Sie ihn und legen Sie ihn in Ihrem Secret-Manager ab. Geht er verloren, erstellen Sie einen neuen Key.

API Keys gehören nie in Client-Code, mobile Apps oder Versionskontrolle.

#7. Erste Anfrage senden

curl https://api-test.worklogx.com/api/v1/customers \
  -H "Authorization: Bearer wlx_test_YOUR_API_KEY"

Die Antwort enthält die erste Seite der Kunden:

{
  "data": [
    {
      "id": "3f2b8c1e-6a4d-4e2f-9b7a-1c5d8e0f2a34",
      "customerNumber": "K-10023",
      "name": "Muster Haustechnik GmbH",
      "active": true,
      "createdAt": "2026-09-14T08:12:45Z",
      "updatedAt": "2026-10-28T15:03:11Z"
    },
    {
      "id": "8a1d4f7c-2b9e-4c3a-a6f1-7e2d9b0c5f18",
      "customerNumber": "K-10024",
      "name": "Beispiel Anlagenbau AG",
      "active": true,
      "createdAt": "2026-09-21T10:40:02Z",
      "updatedAt": "2026-10-30T09:27:55Z"
    }
  ],
  "nextCursor": "eyJpZCI6IjhhMWQ0ZjdjIn0"
}

Ist nextCursor gesetzt, übergeben Sie den Wert als cursor, um die nächste Seite zu laden. Mit limit steuern Sie die Seitengröße (Standard 50, maximal 100).

#Nächste Schritte

• Alle Endpunkte finden Sie in der API-Referenz.
• Pagination & Filter für große Listen und inkrementelle Abgleiche.
• Datensätze mit POST und eindeutigem Idempotency-Key anlegen, siehe Idempotenz.
• Fehler anhand von code behandeln, siehe Fehler.