Preliminary Remarks
An API access token is a unique mapping feature for retrieving, modifying or creating the company's data via the API. API tokens can be generated for different purposes and assigned different authorizations. Developer teams need API access tokens to program integrations to Frisbii Media, among other things. API access tokens can also be created for different use cases, such as access by third-party applications or team members.
In the list view, the column Status shows whether the token is active or expired. The token Age column shows how long the token has been active.
older than 6 months - status symbol is set to Active. The number of days is orange.
older than 1 year - status symbol is set to active. The number of days is red.
Expired token - status symbol is set to Expired with a red background
Note: For security reasons, we recommend renewing the token manually on a regular basis or using the automatic renewal option.
Create API access token
Click on +Create Personal Access Token.
Assign the Name* of the token.
Enter optional Description .
Access Rights* determines whether the token is authorized for reading and writing or for reading only.
Determine Applications* by using the drop-down menu. They determine for which applications the token may be used.
Expires on: A date on which the token expires can be defined here. As soon as the token expires, access to the Frisbii Media System is blocked.
Checkbox Auto renewal every x days: If activated, the token is automatically renewed and a callback can be set to inform a third-party system.
Renewal Mail Recipient to which the information is to be sent that the token has been automatically renewed.
Callback Settings
A callback can be set up to transfer the information to a third-party system that the API access token has been renewed. Callbacks only need to be set up if the automatic renewal of the token has been activated. The callback transmits a unique key that must be redeemed via the API
endpoint /apiAccessTokens/requestRenewedToken within 2 hours in order to receive the updated token. If the unique key has not been redeemed within 2 hours, a new callback is triggered after 24 hours. Once the unique key has been used, the old token is valid for a further 24 hours before it finally expires.
Manage API Access Tokens
The token can be managed either in the list on the right via Actions or in the detailed view via the action bar at the top.
Note: The token can only be renewed in the detail view.
Copy Token
Click on Copy in the detail view below the token.
The token is copied to the cache and can be inserted elsewhere.
Deactivate
Click on Deactivate.
In the dialog box, it is pointed out once again that deactivation cannot be undone.
If you really want to deactivate the API access token, click Deactivate.
Edit
The API access token can be edited to a limited extent. The following can be edited:
Description
Automatic renewal
E-mail recipient
Callback settings
Renew Token
In the detail view in the action bar, the token can be renewed manually via Renew Token. The following must/can be set in the dialog box:
End date of the existing token* determines when the existing token should expire.
Name of the new token* determines the name of the renewed token.
Description can be added.
Frisbii Media API documentation
The Frisbii Media API documentation contains all the necessary information on how the API can be used in conjunction with Frisbii Media.
API endpoint for access tokens: /apiAccessTokens/requestRenewedToken