Comm100 API Introduction

Comm100 offers APIs for Live Chat, Bot, Ticketing & Messaging, and Reporting. With Comm100 API, you can:

  • Integrate your applications with Comm100 system to achieve seamless data sharing. 
  • Help businesses automate their service and enhance the customer support capability with innovation projects.

To learn how you can utilize Comm100 API, see API Help Guide.

Comm100 allows you to access its APIs via the following authentication methods:

  • API Key Authentication
  • OAuth Authentication 
Note:  API usage limits for each IP address is 300 API calls every 5 minutes.


API Key Authentication–Finding Your API Key

To implement Comm100 Live Chat API, you first need to start with 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.
  3. Expand the More Information section.
    kb-apiintro-02.png
  4. Check Your API Key at the bottom of the My Profile page.
    kb-apiintro-03.png

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.


OAuth Authentication–Adding OAuth Client

An OAuth Client is a token-based method of authentication which allows a third-party application to access Comm100 API using OAuth protocol.

To add OAuth Client, follow these steps:

  1. Log in to your Comm100 Control Panel. 
  2. From the left navigation menu, go to Global Settings > Security > OAuth Client.
  3. Click New OAuth Client.
    kb-apiintro-04.png
  4. Enter the following OAuth Client details, and click Apply:
    • Client name: The Client name is displayed to users when asked to grant access to your application or when viewing all apps that have been granted access.
    • Description: A short description of your Client for users to consider access to your application.
    • Company: This name is displayed when users are asked to grant access to your application. The name helps users understand to whom they are granting access.
    • Client ID: Used as the identifier of your Client in code.
    • Redirect URLs: Specify the URL (comma separated) that Comm100 should use to redirect users after they decide whether to authorize your application to access Comm100. The URLs must be absolute and not relative.

kb-apiintro-05.png

Your OAuth Client is successfully created and listed on the OAuth Client page. From the Operations column, you can edit or delete OAuth Client.
kb-apiintro-06.pngIf you choose to edit the OAuth Client, you see the secret token under the Client Secret section. Apps use this secret token to redirect to your client. The secret is displayed in its entirety only once, so it becomes vital to save it in a safe place. You can regenerate and copy the secret token.
kb-apiintro-07.png

Regenerating the secret revokes the old one, and you need to re-authenticate with the new secret to access the API.kb-apiintro-08.png