i-effect Manual

Generate API tokens

In order to use the REST API of the product, a so-called API token is required. It is used to authorize access to i-effect.

These instructions explain how to generate such an API token and where this token has to be used afterwards.

How to create an API token with WebControl?

Within the WebControl application, the token administration is located as an independent selection in the Settings area in the tab Sytem settings.


image2020-9-30_9-23-57.png

The Manage Token button opens a dialog window in which an API token can be created.

image2020-9-30_9-24-8.png

Here the selection of the function Create new token leads to the generation of a new API token.

warning  For this function the user must have *SECADM rights.

image2020-9-30_9-24-16.png


image2020-9-30_9-24-24.png

The token generated here can now be used for authentication in the application as described below.

as a parameter named authToken or in the header as X-Authorization = Bearer $token.

As parameter

The parameter authToken can be used to pass the API token as a parameter.

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

As HTTP header

Using the header X-Authorization, the API token can also be passed in the form Bearer $token.

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