API Keys are used to grant permission to a resource in the BRYTER tenant. Environment API Keys allow third party systems to access modules and databases in a particular environment.

Environment API Keys allow you to access data available in databases in each of your environments via API calls and can be managed by a Tenant administrator from the configuration panel of an individual environment in the Admin Console.

✅

If you don’t have your API key access - Please register here

All keys that have been issued for an environment can be found on the “API Keys” tab of the environment’s configuration panel. Clicking the clipboard icon next to a key will copy it to your clipboard.

An administrator can generate any number of API keys. Database keys are scoped to a specific environment (i.e. TEST, LIVE, or client environments if Multi-Client Publishing is enabled), and enable access to read and write all data in databases for that environment.

❗

These keys MUST be kept secret, as anyone with a key can access and modify all of the data or execute modules in the environment.

Keys can be given a name for reference, i.e its use or the owner of the key.

To revoke a key, click “revoke” and confirm the name of the key. This will remove this key’s access to data, but it will remain in your list for reference.

♻️

API keys are valid for one year. Before expiration, we suggest generating a new key and rotating to it in your application.

⏰

Since BRYTER uses browser-based authentication, the refreshing of tokens or keys is not supported.

Utilizing an API Key

In each request, you will notice the API key is appended to the request header in the format of 'Authorization: Bearer <Api Key>'.

All requests should be made to your tenant URL, i.e. app.bryter.io, brandname.us.bryter.io, etc.

⚠️

Attempting a request with an invalid or expired key currently returns an HTTP 404 Not Found response. In the near future, this will be updated to return HTTP 401 Not Authorized. These documents will be updated to reflect this change when it is implemented.

Execution API Reference