API Keys

Defining the API Key

To be able to access the Rest API, it is necessary to generate and save at least one "User API Key" combination.

PLEASE NOTE:

To be able to generate an API Key, users will need to have the Role "Policy Role - Maintain API Key" assigned to them.
There is only one type of API Key - to grant full access to the Rest API.
The level of access to the application via the Rest API is controlled by the Component Security Settings of the user for whom the Key is being generated.
You can create and apply multiple API keys to the same user, but the system will ensure that the combination of Key Name + User is unique.

Setting up an API Key requires these steps:

Navigate Designer Security API Key, and create New.
Define a Key Name.
Select the User for whom the key is generated in Create For.
You need to make sure to select a User who has sufficient access rights to perform all the required activities against the records.
Copy the API Key and save it outside of the web application BEFORE saving the record, as the Key will only be accessible before you do save. Once the record is saved, the Key is no longer displayed, and neither is it retrievable.
Should a Key get "lost", then it will be necessary to delete the existing key and create a new one.

Applying the API Key

Once the API Key has been defined, the user/key combination will need to be applied to the Rest API call.

In your tool of choice to run the API (for example 'Postman'), set the following attributes: