Skip to main content

API Key Management

The Backstory API is a powerful method for delivering Backstory data and analytics wherever you need them.

With the API Keys page in the Backstory Admin Panel, Backstory administrators can generate, pause, and revoke API keys that power their business analytics.

How it works

Backstory administrators can create and manage up to five active API key/secret pairs in the Backstory web application.
​

To create a new API key/secret pair, navigate to the API Keys page in the Backstory Admin Panel.

api.png

The API Keys page lists all of your current API keys organized by type, status, and creation time.
​

To generate an API key/secret pair, click the Generate API Key button. Your new API key/secret pair will be displayed.

Image_2021-09-30_at_11.16.08_AM.jpg

API keys can be paused and revoked in the API Keys page. If you revoke an API key, it will be permanently disabled. Pausing an API key, on the other hand, is a temporary action that can be undone.

To revoke or pause an API key, highlight the key in the API Keys page, click the menu button (three vertical dots), and select your desired action.

To unpause an API key, follow the same flow and click Unpause.

Your API keys carry significant privileges, so ensure they are kept in a safe and secure location.

Have a question about API keys? Email us any time at support@backstory.ai.

Did this answer your question?