API keys are required to authenticate your requests to Chift’s APIs. This guide explains how to create and manage API keys for your account.

​
Creating an API Key

  1. Navigate to the API Keys page
  2. Click the “Add API key” button
  3. Fill in the required information:
    • Name: A descriptive name for your API key
    • Consumer (optional): If you want to restrict the API key to a specific consumer
  4. Click “Save” to generate the key
  5. Copy both your account id, the client id and client secret immediately - the secret will only be shown once. You need those to receive a BEARER token.

The API Key is only related to the environment you are using. You won’t be able to use a sandbox API key for production’s consumers.

The Client Secret will only be displayed once during creation. Make sure to copy and store it securely. If you lose the secret, you’ll need to create a new API key.

​
Consumer-Specific API Keys

When creating an API key, you can optionally scope it to a specific consumer:

  1. Select a consumer from the dropdown menu during key creation
  2. The API key will only be able to access data for that specific consumer
  3. This provides an additional layer of security and isolation depending on your use case

Consumer-scoped API keys are useful when you want to limit access to specific customer data or when implementing customer-specific integrations.

​
Managing API Keys

  • View all your API keys in the API Keys list
  • Delete keys that are no longer needed
  • Create new keys if you need to rotate credentials

​
Next Steps

With your API key created, you can:

Authentication