Other than API use by the cloud-to-cloud integrations (managed in the Console), in the DPS it is possible to let Organization users to create End-user API Keys for a specific business entity (e.g. customers, partners).
For instance, for a specific customer, you can create an API key that will be used by the customer's users to make API requests for its own specific integration.
The creation of End-user API Key is allowed only by an Organization user having the permission to write API Keys.
It is possible to create End-user API keys for Customer, Location, Partner and Organizations.
Creating an End-user API Key
From the editing page of the business entity (Customer, Location, Partner, Organization), under the API Key tab, the organization back-office can create a new End-user API Key.
If it has not yet been created, the page displays a button that can be used to generate a new API key for the selected business entity.
The following screenshots show the generation of the API Key for a Customer.
.png?sv=2022-11-02&spr=https&st=2025-09-05T08%3A05%3A25Z&se=2025-09-05T08%3A17%3A25Z&sr=c&sp=r&sig=Rr0kT0AYJvZuL%2BTuX8RdoIPcZA5D4CR%2Bkm30uifd7tA%3D)
Once generated, it is possible to configure limitations (per-hour and per-month), and permissions.
.png?sv=2022-11-02&spr=https&st=2025-09-05T08%3A05%3A25Z&se=2025-09-05T08%3A17%3A25Z&sr=c&sp=r&sig=Rr0kT0AYJvZuL%2BTuX8RdoIPcZA5D4CR%2Bkm30uifd7tA%3D)
The Delete button can be used to delete the API Key, when done the API Key cannot be used and a new one must be generated again.
Within the API Key details page, it is reported the number of requests made through the API Key during the last hour and during the current month.
.png?sv=2022-11-02&spr=https&st=2025-09-05T08%3A05%3A25Z&se=2025-09-05T08%3A17%3A25Z&sr=c&sp=r&sig=Rr0kT0AYJvZuL%2BTuX8RdoIPcZA5D4CR%2Bkm30uifd7tA%3D)
By clicking on the edit button, it is possible to modify the API Key permissions and limits.
The organization back-office user can specify the permissions to limit the operations a client can perform via API.
When using an API key, user permissions are further restricted according to the API Key permissions.
For more details about available permissions, refer to the User Permissions article.
Request Rate Limit
Note that, the rate limit specified for End-User API Keys is less than the overall rate limit configured for the environment.
This means that when an API request is processed, rate limits are verified in this order:
The DPS overall max requests per hour.
The API Key max requests per hour.
The API Key max requests per month.
Using an End-user API Key
When an API Key has been configured for a specific business entity (e.g. Customer, Partner), by entering the Account, the administrator user of the business entity can access the API Key tab.
The end user can copy the key and use it to make API requests. For more details, you can see the article How to make API request.
In addition, the user can see the number of requests done during the last hour and during the current month, and check whether a limit has been exceeded.
The screenshot below shows the API Key tab for a Customer, but the same is also available for Partners and Organizations.
In case the API Key has been defined on a specific location, the API Key tab is available in the editing page of that location.
.png?sv=2022-11-02&spr=https&st=2025-09-05T08%3A05%3A25Z&se=2025-09-05T08%3A17%3A25Z&sr=c&sp=r&sig=Rr0kT0AYJvZuL%2BTuX8RdoIPcZA5D4CR%2Bkm30uifd7tA%3D)
Note that, the API Key is associated to a specific business entity, this means that only the users belonging to that business entity can use such API Key.