Basic authentication

Most Care and Care Analytics API endpoints use HTTP Basic Authentication via an Authorization header.

🚧

Important

Requests to the Bot v3 API use JWT authentication. All other Care and Care Analytics endpoints authenticate using basic authentication.

We provide several levels of API access. All require enablement by Support .

We recommend creating these distinct API user accounts types:

• A Base API user account - (Optional) A user account that has standard API access to all SMM APIs except the Analytics Reports, Bot, and GDPR APIs. If you are unsure whether your company has a user account with necessary access permissions, contact Khoros Support.

📘

Note

If you do not need multiple user accounts with base API access, simply create an Analytics Reports API user account. Analytics Reports API access also provides access to all base SMM API endpoints (Author, Conversation, Conversation Tag Rules, Listening, Smart Views, Tag, and Work Queues). Then, create separate GDPR and Bot API user accounts.

• An Analytics Reports API user account - A user account that has access to the Analytic Reports API and the base SMM APIs, but not the Bot or GDPR APIs. Analytics API access is granted when you have the Analytics role granted to you by the administrator.
  You can see the Analytics API User Account details in Account Admin > Developer > General Settings > Analytics API. You will need these details when calling the Analytics Reports endpoints.

  The supported APIs are:

  • Analytics Reports
  • Author
  • Conversation
  • ConversationTag Rules
  • Listening
  • Smart Views
  • Tag
  • Work Queue

• A GDPR API user account - A user account that has access to the GDPR API only. The GDPR endpoints permanently delete user details including author profiles and created content. We recommend using a distinct user account to call these endpoints to limit the users able to make such calls.

• A Bot API user account - A user account that has access to the Bot API only. This user account is limited to the specific set of APIs used by bots. We make this separation so that third-party bot developers cannot call other SMM APIs that provide access to SMM data.

These API user accounts should not be granted any other role, including agent, supervisor, admin, or other user roles. Otherwise, the user account will require a password reset 30 days after the last login date.

📘

Note

When removing all other roles for the API user account, you may encounter an error message:

A User Type must be selected in order to save this user.

However, it is still possible to save the changes upon selecting Done Editing.

The following table lists the APIs supported by our recommend API user accounts and the information required to enable them.

Basic Authentication Example

In the example below, we are creating a simple API call using basic authentication. While the example below points to a specific API call using curl, the process is very much the same across supported APIs (except for Bot v3, which uses JWT) whether you're using curl or any other method to call the API.

curl -L -u [USERNAME]:[PASSWORD] 'https://RESPONSE_INSTANCE/api/v2/authors/networks/twitter/handles/TWITTER_HANDLE'