API-Zugang

Um Zugriff auf die API zu erhalten, wird der Benutzer als API-Benutzer (Checkbox im Kopfmenü anhaken) gekennzeichnet.

Über diesen Haken öffnet sich die REST-Schnittstelle. Hier kann man nun anhaken, welche Rechte der API Benutzer haben soll.

Für den API Benutzer sollte keine Berechtigungs-Gruppe eingestellt sein.

Mehr über Mitarbeiter-Einstellungen erfahren Sie hier.

Die komplette Dokumentation der API Schnittstelle für desk4, finden Sie unter folgenden Link: https://demo.desk4.net/q/swagger/

Mit dem API-Benutzer können Sie anschließend ein WebToken zur Authentifizierung erzeugen. Ein erzeugter Webtoken ist 30 Minuten gültig.

In den Body müssen dafür die Benutzerdaten nach folgendem Schema eingefügt werden:

{
"userName": "admin",
"password": "admin",
"branchID": 1,
"killExistingSession": true
}

Beachten Sie, dass die korrekte Methode ausgewählt sein muss (in diesem Fall „Post“).

API Pfad: https://demo.desk4.net/rest/v1/session/webtoken

Das erhaltene WebToken fügen Sie nun im Header in der Form „Bearer +WebToken“ als Value und „Autorization“ als Key ein, um so auf die API zugreifen zu können.

Um auf die Dokumentation der API zuzugreifen, rufen Sie folgenden Link auf: https://demo.desk4.net/q/swagger/

Alternativ können Sie auch die URL Ihrer desk4 Instanz für „demo.desk4.net“ einsetzen.