i-effect Manual

API Token genieren

Um die REST-API des Produkts nutzen zu können, wird ein sogenanntes API Token benötigt. Es dient dazu, den Zugriff auf i-effect zu autorisieren.

Diese Anleitung erläutert, wie ein solches API Token zu genieren ist und wo dieser Token anschließend verwendet werden muss. 

Wie erstellt man einen API Token mit WebControl?

Innerhalb der WebControl Anwendung befindet sich die Tokenverwaltung als eigenständige Auswahl im Bereich Einstellungen im Tab Systemeinstellungen

  image2020-9-30_9-17-59.png

Über den Button Token verwalten öffnet sich ein Dialogfenster, in dem ein API Token angelegt werden kann.


image2020-9-30_9-20-59.png

Hier führt die Auswahl der Funktion Neuen Token erstellen zur Generierung eines neues API Tokens.

warning  Für diese Funktion muss der Benutzer über *SECADM Rechte verfügen.

image2020-9-30_9-21-13.png


image2020-9-30_9-21-22.png

Der hier generierte Token kann jetzt wie im folgenden beschrieben zur Authentifizierung in der Anwendung verwendet werden.

als Parameter mit dem Namen authToken oder im Header als X-Authorization = Bearer $token ein.

Als Parameter 

Über den Parameter authToken kann der API-Token als Parameter übergeben werden.

image2019-2-11_11-12-51.png

Als HTTP Header

Über den Header X-Authorization kann der API-Token ebenfalls in der Form Bearer $token übergeben werden.

image2019-2-11_11-11-5.png