API Token
API token is a unique key used to authenticate a user to access the API. The token is created on the portal and must be added to each API request to authorize access to protected resources.
If API returns data, which contains link with a prefix
/s3/ — this is a link to an image or attached file, they can be retrieved with the same token as for the API.The API token creation is available on the Security page for profiles that have the appropriate permissions.
After clicking the Add Token button, a modal window for creating a token appear where the following parameters must be specified:
- Token name
- Expiration period (available values: 1, 2, 3, 6, 9, and 12 months)
A notification will be automatically sent 3 days before the token's expiration, using the Users - authorization token expires in three days template, informing that the token needs to be updated or a new one created.
- Role that will determine access rights (for more details, refer to Roles in the system and their permissions).
After clicking the Apply button, a modal window will appear with the generated token key, which can be copied:
Please note: The token value can only be copied during its creation. Make sure to copy and save it before leaving the page.
The token can also be copied after closing the modal window, but only before refreshing the page:
After the page refreshes, the token cannot be copied:
