Datenaustausch mittels Workist API
Workist stellt eine REST-API für den Datenaustausch bereit. Über die API:
- laden Sie Dokumente in einen Kanal hoch,
- rufen Sie verarbeitete Dokumente ab und melden das Ergebnis des Imports in Ihr System zurück,
- setzen Sie Absender und Betreff, weisen Dokumente Benutzern zu oder löschen sie,
- übertragen Sie Stammdaten.
Die API arbeitet nach dem Abrufprinzip: Ihr System fragt Workist nach neuen Ergebnissen. Wenn Workist Ihr System bei Ereignissen benachrichtigen soll, richten Sie zusätzlich Webhooks ein.
Weitere Informationen zur Nutzung der API finden Sie in der API Dokumentation.
Lookup-IDs für die API abrufen
Jeder Stammdaten-Import gehört zu einer Lookup-Definition. Lookup-Definitionen legen Benutzer mit der Rolle Manager, IT oder Admin im Stammdaten-Hub selbst an (siehe Benutzer und Rollen).
Die ID einer Lookup-Definition finden Sie an zwei Stellen.
Im Stammdaten-Hub: Die Übersicht zeigt alle Lookup-Definitionen mit ihrer ID. Die ID steht auch auf der Detailseite der Lookup-Definition.
Im Kanal:
- Öffnen Sie die Workist-Oberfläche: https://wb.workist.com/
- Wählen Sie den Kanal, öffnen Sie rechts oben das 3-Punkt-Menü und klicken Sie auf „Kanal verwalten".
- Wählen Sie in der Liste den Punkt „Stammdaten".
- Unter jeder ausgewählten Lookup-Definition steht ihre ID. Ein Klick auf die ID kopiert sie in die Zwischenablage.