Zum Hauptinhalt springen

Quickstart

1. Erstellen eines API Zugriffstokens​

Navigieren Sie in der Workbench zu https://wb.workist.com/customer/integrations/api-integrations und erstellen Sie unter „API-Integrationen" Ihren eigenen Token.

2. Ihre erste Anfrage senden​

  1. Öffnen Sie die Swagger UI: https://api.workist.com/v1/swagger/
  2. Klicken Sie auf „Authorize" und fügen Sie Ihren Token aus Schritt 1 ein
  3. Testen Sie die API mit GET /orders/

3. Authentifizierung​

Die Workist-API verwendet Bearer Token-Authentifizierung.

Authorization: Bearer <Ihr Token>

4. Ablauf der Anfragen​

  1. Eine Bestellung hochladen, z.B. über POST /orders oder über die Workbench
  2. Warten, bis die KI das Dokument verarbeitet hat
  3. Alle zu importierenden Bestellungen abrufen: 
    GET /orders?imported=False&finished=True
  4. Für jede Bestellung:
    • a) Verarbeiten auf Ihrer Seite (z.B. Import in ERP-System)
    • b) Markieren als importiert mit PUT /orders/{id}/mark_imported/

Stammdaten-API​

Für die Übertragung von Stammdaten per API siehe Benutzung der Stammdaten-API.