API Tokens

The web service is authenticated with an API token.

To define an API token, perform the following steps:

1. In the Fabasphere Web Client open the account menu (your user name).
2. Click “Advanced Settings” > “Access for Applications”.
3. In the API Tokens field click “New”.
4. Define the desired settings and click “Next”.
   • Description
     The free-text description of the API token.
   • Valid for
     The web service (e.g., “Standard Web Services for the Fabasphere”) for which the API token should be used.
   • Validity Period
     After the specified period has expired, the API token can no longer be used unless its validity period is extended.
   • Enable IP Range
     Allows to define an IPv4 address range for which the API token is valid. Must be in CIDR notation (e.g., 198.51.100.0/24)
5. Copy the displayed API token that can be used for the authentication of the web service.
   Note: The API token is only displayed once and cannot be displayed again.
6. Click “Close”.

Note: API tokens enable secure access via HTTPS, independent of the user’s password. The API token can be revoked at any time and expires automatically after the defined period if it is not renewed. The API token can only be viewed once.