Under the API tab, you can find a dedicated page within the Promotion module designed to help you easily manage API keys for accessing the Promotion Engine API endpoints.
This page lets you:
Generate new API keys for different purposes, such as:
Integrating with e-commerce systems to retrieve and apply promotions
Enabling a test environment for safe testing
Supporting promotion-specific landing pages
Providing access to external agencies or partners
Using internal monitoring or analytics tools
Revoke (delete) API keys when they are no longer needed
Who should use this page?
Developers implementing the Promotion Engine
Find the detailed integration guide in the documentation.Admins managing access control for promotion APIs
Anyone responsible for maintaining secure and organized API access
How to use the API Key Manager
Viewing API Keys
Under the API tab of the Promotion Engine UI, you will see a list of your existing API keys displayed in a grid with the following information:
Name: A unique label for the API key, making it easier to identify the key
Created At: The timestamp indicating when the key was generated.
For security reasons, the actual API key is never displayed in this list. You can only view the key once, right after generation. If you lose it, you must revoke the old key and generate a new one.
The list is sorted by creation date (oldest keys appear first).
.png)
Generating a New API Key
Click the Generate button located at the top right corner of the page.
A pop-up will open, asking you to enter the Name of the API Key
Give your API keys clear and meaningful names and purposes to avoid confusion later.Click Generate to create the key, or Cancel to close the popup without action.
Once generated, the API Credential pop-up will display your newly generated API key.
Important: Save this key securely now. Never share them publicly or expose them in unsecured locations.
For security reasons, you will not be able to retrieve it again from the UI after.You can click the Copy API Key button or click the key itself to copy it to your clipboard for easy use.
Close the pop-up when done.
Deleting an API Key
If you no longer need an API key or suspect it has been compromised, you can revoke it to maintain security.
In the API Key grid, click the red dustbin icon on the row of the key you want to revoke.
A confirmation pop-up will appear with a warning that the delete action is irreversible. The key will be permanently deleted and cannot be recovered.
Click Delete to permanently remove the key, or Cancel to keep it.
