Creating Public API Clients

How to create public API clients that will be used to integrate Delve's public API with third party applications.

If you need to consume Delve's public OpenAPI-compatible API, this section will guide you through the steps necessary to get Delve's data through OAUTH2 authentication mechanism.

Create an applicative user in Delve

It is recommended to not mix API access to applicative users and regular users in Delve. Creating a new user dedicated to API access, with rights that are limited to the scope of these accesses is the best way to proceed.

Refer to the Delve's User Guide section on Creating new users and Adding members to a team using the correct Team access rights to better scope how this user should be created.

Get a Client Secret and Client ID for this applicative user

Once the dedicated applicative user is created, a new OAUTH2 API Client ID and Secret needs to be generated.

This can be done directly in Delve's frontend by navigating to the Settings → Public API Clients view.

Clicking on the "+" icon at the upper right corner brings the Public API Client creation menu, where you can choose the following parameters:

⚠️ The Redirect URI (also named "callback URI") depends on the application with which you will use Delve's Public API. Choose the one that corresponds to your need, usually documented by the application consuming the OpenAPI through OAUTH2.
If you're unsure or just want to try the API usng Swagger UI, you can start with the following URL: https://<YOUR_INSTANCE>
  • Description: Choose a description for your Public API Client in order to remember the reason you created it. It will be visible in the interface afterwards.
  • Scopes: Choose from read_only (only GET will be supported) or full_access (GET, POST, PATCH supported).
  • Redirect URI: Depends on the application with which you will use Delve's Public API. It is usually documented by the application itself when accessing OpenAPI through OAUTH2.



Once created, you will be provided with a new Client ID and Client Secret that you need to note down for future use in your API authentication: