en:what_is_my_api_key

This is an old revision of the document!


What is my API-Key?

API key is needed to authenticate your requests via REST or SOAP. Navigate to Settings > API.

In clients that are enabled for omnichannel and use REST, existing keys are listed in the “REST” tab.
It is recommended to create a separate key for each application that uses REST. To do so, follow the steps here:

  • Click on the “REST” tab.
  • Choose action “Create REST API key”.
    • Step 1: Assign a name for the application that will use the new key.
    • Step 2: Specify which IP addresses are allowed to use the new key. To do this, enter one or more IP addresses and click “Allow”. Alternatively, select “Allow all”.
    • Finalize action by clicking the “Create” button.
  • The created key is now listed with assigned name.

For the use of SOAP, you can find the API key of the client in the “SOAP” tab.

en/what_is_my_api_key.1649328579.txt.gz · Last modified: 2022/04/07 12:49 by fw