How to connect with API Key authentication
  • 08 Jun 2022
  • 1 Minute to read
  • Dark
    Light

How to connect with API Key authentication

  • Dark
    Light

Comm100 allows you to access its APIs via the following authentication methods. Learn more about the API Authentication.

  • API Key Authentication
  • OAuth Authentication

Step1: Finding Your API Key

As an agent, you can find your API Key in your profile. To find your API Key, follow these steps:

  1. Log in to your Comm100 Control Panel.
  2. On the bottom-left of your navigation menu, hover over the avatar and click the agent name.
    kb-apiintro-01.png

The My Profile drawer appears.

  1. Expand the More Information section.
    kb-apiintro-02.png

  2. Check Your API Key at the bottom of the My Profile page.
    kb-apiintro-03.png

  3. If you want to change the API Key, you can click Reset.

Now that you have got your API Key, you can go ahead to implement your API. Should you need any help with Comm100 API, contact Comm100 Support Team.
### Step2: Use the API Key to call an API
To call an API using the OAuth Access Token, follow these steps(Postman):

Postman

  1. Log in to Postman.
  2. Go to Home > Create New > HTTP Request.(Menu might be differect on different Postman version)
  3. Select the GET method and provide the API request URL. The following example requests a Get a single Chat API: https://api17.comm100.io/v4/livechat/chats/93561bad-bc6d-4d97-b6da-6f5d91d0f18c?siteid=50100000
    Note:When using API key to call the interface, you need to bring the parameter siteId
  4. Go to the Authorization tab and choose the authentication type as Basic Auth.
  5. Provide your email as the basic auth username.
  6. API_KEY as the password.
  7. Click Send.
    MicrosoftTeams-image (3).png

To learn about Comm100 API request URL, see Server API (Restful) Reference.


Was this article helpful?