An overview of Khoros Care APIs
Khoros Care has APIs to integrate and interact with Khoros Care and Care Analytics, and the Automation Framework.
- The Khoros Care v1 and v2 APIs enable you to integrate with the Khoros Care Response app.
- The Khoros Care v3 APIs are used with the Automation Framework
- The Care Analytics API enables you to generate Analytics Reports exports
The table below provides the base URLs and authentication mechanism used with each of the Khoros Care APIs.
API | Base URL/API Gateway/Description | Authentication |
---|---|---|
Care API v1 | https://your_care_instance.lithium.com/api/v1/ | Basic authentication |
Work Queue v1 | Filter conversations by work queue | |
Care API v2 | https://your_care_instance.lithium.com/api/v2/ | Basic authentication |
Authentication v2 | Generate a JWT for HTTP authentication to Bot API v3 | |
Author v2 | Create author integrations between Khoros Care and CRMs | |
Bot API v2 | Build Facebook and Twitter bot integrations | |
Conversation v2 | Retrieve conversation IDs and details | |
Conversation Tag Rules v2 | Retrieve conversation tag rules in Care. | |
GDPR v2 | Remove personal data from Khoros Care | |
Listening v2 | Bring content into Care from source platforms not supported with out-of-the-box integration | |
Smart Views v2 | Get a list of all Smart Views and their IDs | |
Tag API v2 | Retrieve details about tags in Response | |
Work Queue v2 | Get a list of all non-archived work queues and their IDs | |
Care API v3 | EMEA/APAC: api-eu.app.lithium.com/ US: api.app.lithium.com/ All Dev instances use the US gateway | JWT authentication |
Bot v3 | Create bot integrations using the Automation Framework | |
Care Analytics API | EMEA/APAC: analytics-api-emea.lithium.com US: analytics-api.app.lithium.com | Basic authentication |
Analytics Reports | Generate Analytic Reports exports |