Creating an API Key

Note:

Note that, in order to create an API Key, you need to be connected to the Platform web page with a user who has the API_KEY_BACKOFFICE role in Keycloak.

  1. Access to the API Key management view in the web console.

    API Key Management from the Settings Menu

  2. Click on the plus button in the API Key management view header.

    API Key Management View Create Button

  3. Name the API Key (usually with the name of the third-party application that will use it). Optionally give an expiration date to your API Key. And finalize the creation by clicking on the Create button.

    API Key Creation Configurator 1/2

The API Key is now created and a confirm dialog displays it.

API Key Creation Configurator 2/2

Note:

Note that the API key should be stored with care as it cannot be recovered. Lost API Keys need to be deleted and recreated.