Generating an API key

Before you get started

You can create API keys for employees or bot users. This is a user (or developer) identification code used to access our APIs. API keys are used to track and check API usage. The API key is used as a unique identifier and a secret token for authentication, and a set of access permissions is linked to it.

Be careful about the permissions you give to the key and those to whom you transfer the token. The person with this token can obtain information which may be confidential.

Create a new API key

To create a new API key, you must go to the cogwheel Authentication, SSO and API API keys. If you do not have access permissions, contact your administrator to generate an API key for you and if you are an administrator without access to the roles, contact the Help desk.


Click on Generate a new API key to create a key.


In the creation window:

  • You could customize the name you want to link to this key
  • Select the permissions you want to match with this key (a permission must be checked here, but you can then edit all the permissions of the key in the roles as specified below).

Advanced options: you have the option to customize the key. However, you must respect the GUID (globally unique identifier) format, a unique identifier with a size of 16 bytes (e.g. [%1$s:3F2504E0-4F89-11D3-9A0C-0305E82C3301]).


Once the key is generated, you can copy this key on mouseover:


Edit the permissions associated with an existing key

If you want to edit the permissions associated with a key, go to the role administration by clicking on the blue "role administration" link:


Tip: If you have Poplee Core HR and you need to restrict the access of the key to only some data in the HR file, you can create a dedicated section in Poplee Core HR and give the visibility rights for this section only. As a result, people with the API key token will only be able to access these data.

Once the key is created, you can use our APIs. To find out more about our different APIs, open the API documentation.

Page content

Was this article helpful?
1 out of 1 found this helpful