Documentation
Log InRequest Live Demo

Managing Portal API Keys

Create and manage API keys for CommPeak Billing API.

An API Key is a secret unique code used to identify a client. API keys let your applications access data through the CommPeak Portal API instead of using a username and password. You can create more than one API key and delete previously created keys at any time to keep your integrations secure.

📘

NOTE

API keys can only be created once your customer account is fully activated. If your account is still pending activation, the Add API key button will be unavailable.

Create an API key

  1. Log in to My CommPeak.

  2. Expand Settings in the main menu and open the API Access tab.

    Screenshot of the Settings menu tabs

    Settings menu tab

  3. Select the API Keys tab.

  4. Click Add API key in the top-right corner of the page.

    The API Keys page with the Add API key button

    The API Keys page

  5. A panel slides in from the right. Fill in the details:

    • Application name: (required) a name that helps you recognize the key later.
    • Application website: the URL of the application that will use the key.
    • Platform: (required) choose Web, Mobile, Desktop, Server, or Other.
    • Default SMS Stream and SIP Account for Calls: (optional) select those that apply. Note that only JWT enabled SIP accounts can be selected.
    • Full access toggle: enable to allow all services available (Dialer, Lookup, SMS Platform, and Speech Recognition.
    • IP ACL: (optional) restrict the key to specific IP addresses (an Access Control List, or ACL). Type an address in IP-only, CIDR format (for example, 1.1.1.1/32 for a single IP) and click Add. Repeat to add more entries. Leave it empty to allow requests from any IP.
    The Create API Key form

    Creating an API key

  6. Click Create. For your security, you will be asked to re-enter your account password to confirm.

    The Confirm Password dialog

    Confirm your identity with your account password

  7. The new key now appears in the list on the API Keys page.

View an access token

For security, access tokens are hidden by default and shown as ********. To reveal a token, click the eye icon next to it and confirm your identity with your account password. Click the icon again to hide the token.

A revealed access token in the API Keys list

Revealing an access token

🚧

Keep your access token private

Treat your access token like a password. Anyone who has it can use the API on your behalf. Use the IP ACL field to limit which IP addresses may use the key.

Edit or delete an API key

On the API Keys page, each key has two actions:

  • Edit: opens the Edit API key panel so you can update the application details or IP ACL. Click Save changes when you are done.
  • Delete: (trash icon) permanently removes the key. Any application using it will lose access immediately.

Next steps

After creating an API key, check out the API documentation for integration details.

Updated 12 days ago

Did this page help you?