An API is the messenger that runs and delivers your request to the provider you’re requesting it from, and then delivers the response back to you. It can also be helpful to envision the API as a way for different apps to talk to one another. If you would like to know more about ClearPoint’s API, please visit our [API support article](https://support.clearpointstrategy.com/en/articles/8649669-automation-integration-access-the-api-getting-started-with-the-api).

API keys allow other apps to access your account without you giving out your password. You will need to generate an API Key if you would like to integrate an app with your ClearPoint account.

Note: Data Loader Keys will now be separate from API Keys. For instructions on Data Loader Keys, see [Data Loader 2.0](https://support.clearpointstrategy.com/en/articles/6845322-clearpoint-data-loader).

Follow these steps to create a new API Key.

From the Control Panel click on **System Settings**\
Select **System setup**\
Click on **Integrations** under Enterprise Features

Make sure you are in the **API Keys tab**\
Click on the **Plus icon** to create a new API Key

Under **API Key Name (Application)**, enter the name of the new API Key, in this example, ‘Integration’.

We recommend using the name of the application that will be using the key, this will help you easily identify to which application you are granting permissions.

Under **Expires**, set an expiration date for the API Key you are creating

Click the "API Key Name (Application)" field.

Your account will automatically be the **Mapped User Account**

Only elements that the mapped user can access will be accessible via this API key.\
You can change the Mapped User Account if you would like the API key to be based on the account credentials and permissions of a different user.

Once you are done, click **Save**

You will find the newly created API key under API Keys

Show Deleted
FM
Integration
Fernando Montenegro
Expires in 1 year

Note: The API key allows external applications to perform actions “on behalf” of the mapped user. The mapped user name will appear in Revision History.

From the API key window, you can Delete, View and Edit, existing API keys. 

If you suspect that an API key has been compromised or you no longer use the integration that was accessing your account through an API key, you should disable that API key by deleting the key.

You can also change information about the API key such as the name, expiration date, and mapped user.

From the Control Panel click on **System Settings**\
Select **System setup**\
Click on **Integrations** under Enterprise Features\
Locate the **API key** you are going to be working with, in this example, ‘Integration’.

Click on the **three dots icon** where you will find three options\
**Edit API Key**, use this option to edit the name of the API Key, the expiration date or the Mapped User Account

Use **Delete API Key** to delete the API Key\
Confirm you want to delete the API key by clicking on the red button

**Edit API Key** will display the API key values

ClearPoint API keys have two different parts. The first part is the **Access Key** and the second part is the **Security Key**. The header keys should be “accessKey” and “secretKey”.\
\
To use your new API keys, add them as headers for any HTTP call that you wish to make.

FqhmPrJMEzZHShznGLyMBeZEqHy5wOL/N20U8dP1j3qBDVNwF+4JSzlO3Ut6HDrpjljSYegbGojnv34sDqa4ggGp9eCnVHkroZ12fVujtCYXVH/AUKEaxwNxYNaIQrXT

Note: It is important to note that both keys need to be included as request headers when making calls to the ClearPoint API. These are highly sensitive and should never be shared with others.

Using API keys when you are not an Administrator

If you are not an admin, you can still use API keys generated for you by an admin. 

Click on your **profile icon** at the upper right-hand of your screen\
Select **Edit Profile**\
Navigate the **Security tab**\
You will see the APIs generated for your user under **API Keys**

Automation & Integration - Access the API - Getting and using ClearPoint API Keys

What is an API and what are API keys?

Getting API keys

Using API keys

Using API keys when you are not an Administrator