Getting Portal API Keys and Documentation

An API Key is a secret unique code used to identify a client. API keys are used for accessing data instead of using a username and password. It is possible to create more than one API key and delete previously created keys to ensure a client's security.

To get an API key via CommPeak Portal, follow these steps:

1. Log in to CommPeak Portal.

2. Expand Billing in the left pane and open the API Keys tab.

   

3. Click CREATE API KEY.

   

4. Enter the application name, description, and website, and choose its type and platform in the form that appears. Click CREATE API KEY again.

   

5. The API Keys tab displays all the created API keys. To obtain one more key, click the plus icon next to the API key number.

   

6. Check out the documentation after creating an API key to view integration details.

📘

NOTE

You can edit or delete your API keys at any time.