API Tokens

Create an API Token

Before you can use the Streamkap REST API, you'll need to generate an API token. API tokens are scoped to Services and Roles in the Streamkap platform.

To generate an API token:

• Navigate to the Services page.
• For a Service, click on the menu and then API Tokens.
• Click Create API Token:
  • Enter a description e.g. 'Read-only API access'
  • Choose the role(s) it applies to e.g. Read Only
• Click Create Token.

Once the API token is created, you will have one chance to copy and save its Token somewhere safe. Once you have done that, click Done.

Once you have a Client ID and Token, you can make a call to Get Access Token REST API endpoint with those values to get your REST API access and refresh tokens.

Manage API Tokens

📘

Tokens can't be moved between Services or have the Roles scope changed after they're created.

To create, view and delete API Tokens:

• Navigate to the Services page.
• For a Service, click on the menu and then API Tokens.

⚠️

The Token (or 'secret') is only shown once. If you have lost or forgotten an existing Tokens' secret, you will need to delete it and create another.