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.
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.
Click the button labeled "Generate Key" and the new API key will be generated.
Once the key is created, you will see it in the list. To access the API key, click the copy to clipboard icon:
You can use this API key to access the Cordial API test platform: http://api.cordial.io/docs/.
Navigate to the test platform and paste the API key into the authentication field at the top of the page.
There are two ways to authenticate your API key.
Enter the API key in the form field in the top header and select the "auth" button, or when you try to make an API call you will be prompted to authenticate access:
- User Name: Your API key
- Password: No password is needed
If this does not give you access, then your IP address was not whitelisted properly.
In the next article we'll learn about Account Settings.