API tokens are unique identifiers that allow third-party services to securely communicate with an application or system. API tokens are used frequently in integration scenarios where you need to establish communication between the Staffbase platform and third-party applications or systems. You can create API tokens in the Studio for third-party services to establish communication with the Staffbase platform. You can then use the tokens to request access to the Staffbase platform. You can create API tokens with different levels of access permissions.
Learn about the required access level for your specific scenario before generating an API token.
Creating an API Token
- In the Studio, click the gear wheel to open the settings.
- Under System ,click API Access.
- Click Create API token.
The API Tokens page opens. - Click Create API token.
The Create API token dialog opens.
- In the Token Name field, provide a name.
- Select an access level.
The level of access required for the API depends on the business use case. For example, Restricted Read-only access is sufficient for RSS feeds, whereas advanced integrations require Administrative access. Learn more. - Click Create.
The API token is created. The API Tokens overview page opens.
You have successfully created an API. Now, you can retrieve the token you created.
Retrieving the API Token
Once you have created the API token, you need to retrieve it. Then in order to use it, you can copy it to your clipboard.
- In the Studio, click the gear wheel to open the settings.
- Under System, click API Access.
The API Tokens page opens. - Click the copy icon next to the API token to copy it to your clipboard.
You have copied an API token. You can use the copied API token to establish communication between third-party services and the Staffbase platform.
Comments
0 comments
Please sign in to leave a comment.