API-Zugang

Um Zugriff auf die API zu erhalten, müssen Sie zunächst einem Mitarbeiter die „API-Berechtigung“ in den Einstellungen zuweisen. Dazu müssen Sie den Haken in der Checkbox „API-Berechtigung“ im jeweiligen Benutzer setzen.

Mehr über Mitarbeiter-Einstellungen erfahren Sie hier.

Mit dem API-Benutzer können Sie anschließend ein WebToken zur Authentifizierung erzeugen. In den Body müssen dafür die Benutzerdaten nach folgendem Schema eingefügt werden:

{
„userName“: „admin“,
„password“: „admin“,
„branchID“: 1,
„killExistingSession“: true,
„userDevice“ : „App“
}

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

 

 

 

 

 

 

 

 

 

 

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: demo.desk4.net/swagger

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