skip to Main Content

By pressing Add Key navigates you to a new pop up window as shown in the example where you fill out the new API keys information. Some fields are mandatory some are optional for API key creation.

API key creation fields

Description String
Mandatory
It is a note for the user to describe what the API key is used for.

Role Enum
Mandatory
Gives a role to the API key:
  • Web – gives readability;
  • User – some management;
  • Administrator – has full control;

If you filled out all the information correctly then you can press the icon button Save and the API key will be saved.

If the information is filled out incorrectly the information bar will be shown in red. If you did all the steps correctly the API key should be created in the Settings → API Keys and shown as in an example. After creation you can Edit the key or Delete the API key from the list.

If the information is filled out incorrectly the information bar will be shown in red as in an example below.

Back To Top