API Keys

An API key is a used to authenticate access when making API calls to the Cordial system.

The IP address from where you access the API will need to be whitelisted when you create the API key.

Creating an API Key

To create a new API key, navigate to the account dropdown and select API keys.

Click the button labeled New to add a new API key.

Give the API key a unique name and add the IP address from where you will be accessing the IP.

You can add multiple IP addresses for each API key and you can also use CIDR notation (Ex: 0.0.0.0/0)

Click the button labeled "Generate Key" and the new API key will be generated.

Accessing an API Key

Once the key is created, you will see it in the list.

To access the API key, click the copy to clipboard icon: and copy the key.

For API testing , use the API key to access the Cordial API test platform (powered by Swagger). Learn more about using Swagger to access and test the API.

In the next article learn about Account Settings.