How can we help?

API Keys

Overview

An API key is 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 menu and select API Keys.

Click New to add an 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).

Tip: You can calculate CIDR values for a given IP range (between two IP addresses) using the CIDR to IPv4 Conversion tool and then whitelist those values to account for the entire range.
Note: To find your IP address, click here.

Click Generate Key and the new API key will be created.

Accessing an API Key

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

Note: The list contains censored API keys generated by other account users but you can only view and access API keys generated by your own user account.
Note: As a security recommendation, for legacy keys that are not owner tracked, you will be prompted to generate a new API key. Legacy API keys will continue work.

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.

Comments

0 comments

Please sign in to leave a comment.