API Reference
AcademyOptiCircleoptimove.com

Generating API Keys

You can gain access to your Optimove data and trigger actions within Optimove via API. To enable an efficient and secure process, API requests are authenticated using API Keys.

An API key is a code that is passed in by computer programs calling an API to identify the calling program and to provide access to the resources that the caller is authorized to use. The key acts as a secret code that is used to identify the user, application, or developer. It is also known as an API token.

API Keys ensure maximum security and only provide authorized applications access to the resources. By using API keys, we can easily revoke access to a specific application without impacting other applications.

Using an API Key does not require a preliminary request to the /login endpoint. By embedding the key in the request header, the user is “always logged in”.

📣

If you are a third party collaborating with us, we kindly request the client you're assisting to generate a key for your use.

How to Generate an API Key

  1. As an admin user, go to the Settings page
  2. Under General, go to API Key Management
  3. Click the “+ New API Key” button

  1. Select a “Nickname” - an identifiable name easy to connect to the it’s actual user.
  2. Fill in your Contact Email
  3. Select an Access Type:
    • Select Admin for API full permitted user.
    • Select Integrations for channel integration purposes.
  4. Click on “Activate key”
  5. You will then be provided with a unique API key that will be used for authentication purposes.

Please note

API keys should be stored securely. We should never hard-code the API key in the application code or store it in plain text. It is recommended to use a secure key-value store like HashiCorp Vault or AWS Secrets Manager to store the API key.

For more information on API Keys, refer to the Authentication Guide.

Access Types

There are three options for Access Type:

  1. Admin

    1. A full permitted user, permitted to access any of the API calls and all of Optimove’s API available functions

  2. Integrations - for 3rd Party User

    1. Third-party keys are limited in access permissions.

    2. Only a part of the API calls are available. You can find the list here.

    3. Within the available ones, only certain attributes can be limited to be shared with the 3rd Party provider.

    4. Additionally, only specific channels can be enabled to a certain CID.

    5. For both limitations, if none is selected, all channels are permitted.

  3. Transactional API User

    1. The "Transactional" user role provides access to all endpoints, including the "transactional" functionality.
    2. Users with this role can utilize the full range of API endpoints, including those related to transactional operations.
    3. Please ensure that users are assigned the appropriate roles and permissions based on their intended usage and the level of access required.

Best Practices for using an API Key

  1. Use a different API key for each application.
  2. Regenerate API keys periodically.
  3. Never share API keys on public platforms like GitHub.
  4. Use HTTPS to transmit API keys.
  5. Set up rate limits to control the usage of API keys.
  6. Monitor API key usage regularly.

By following these best practices, we can ensure the security of our APIs and prevent unauthorized access to our resources.

🚧

Please use your API key ONLY for production purposes. All uses of this key will affect your production site.