Documentation

Using API keys

The API keys area lets developers manage API keys to authenticate to the Studio APIs.

From API keys in the Developer area, you can create and revoke the API keys available for your commercetools Frontend project.

The API keys area displaying the Add key button and list of available API keys

API key scopes

All API keys have a scope that constrains the endpoints to which an API key has access and whether an API key has read or write access to an endpoint. Scopes are defined in the Studio for a single commercetools Frontend project when creating an API key. Once you create an API key, you cannot redefine the scopes.

Studio only supports the build-upload scope, which lets you upload a build to the Studio.

Create an API key

To create an API key, follow these steps:

  1. From the Studio home page or from the left menu, go to Developer > API keys.
  2. Click Add key: the Create new API key dialog opens.
  3. In the Name input field, enter a descriptive name for your API key.
  4. Click Create key.
  5. Click Copy to clipboard to copy the API key and save it in a safe location.
  6. Click I've copied the key.

You can create and use an API key from any environment because the API keys are independent of the Studio environments.

Revoke an API key

To revoke an API key, follow these steps:

  1. From the Studio home page or from the left menu, go to Developer > API keys.
  2. Hold your pointer on the API key you want to revoke.
  3. Click Edit icon: the Edit API key pane opens.
  4. Click Revoke.

All API calls using a revoked API key will fail.