How to create an API Key

To create and manage API Keys, you would need to be an Enterprise account holder. This article will go over the steps on how to create, use and manage API Keys.

1. Make sure you are an Enterprise account holder. Go to the API Keys page in the Admin Section of the left Nav bar

2. Once on the API Keys page, you will see a yellow circle with a + inside it, use that to add new API Keys.

3. This will open a new form to add an API Key. The API Key is system generated and can not be changed/ edited. Please note the API Key in a secure location since it is visible only once and will not visible again after saving.

4. Add any name which will help identify the API Key for your purposes. The API Key must either have a security role or must be a super user. If the API Key has super user privileges then the API Key would allow access to all system APIs. If you want to restrict API access and permissions based on roles, please choose an appropriate role which has the required permissions and assign the respective role to the API Key.

5. Click save and proceed. The following pop up will be seen on clicking the Save button. Make sure you store your API Key in a secure location as it will not be displayed again.

6. Click on YES after successfully saving the API Key. You will now be redirected to the API Keys page where you should be able to see all the Keys you have created.

What is editable in the API Key and How to edit it?

Only the API Key Name and security permissions(changing security roles and changing super user permissions) are editable. You cannot view or edit the API Key again.

1. Click on the 3 dots on the right of any API Key which you would like to edit.

2. Click on Edit.

3. This will open the specific API Key screen as below. Make edits in Name and Security Role/ Permissions for Super User as required and click on save. Once saved, you should be able to see the changes reflected on the API Keys page.

How to Delete an API Key?

1. Click on the 3 dots of the API Key you would like to delete as discussed previously and click on Delete.

2. Confirm the ID of the API Key you are meaning to delete and proceed with deletion by clicking YES.

You will notice that the API Key has been successfully deleted from the API Keys page.

How to use API Keys ?

You will need to add an api_key header to your API request with key as 'api_key' and value as the Key generated in the first step.