CMS API

Product

MonitoringWhat is Conductor Monitoring?

Plan

What is my plan?
Essentials
Growth
Enterprise

Getting Started

Overview

Integrating the CMS API into your publishing workflow triggers priority auditing of the page you're working on for on-the-fly auditing. This allows you to see the results in Conductor Monitoring immediately after making a change.

Note!

Conductor provides APIs for several different uses across its Conductor Monitoring and Conductor Intelligence products. This article describes Conductor Monitoring's Reporting API. If you are looking for information about a different API offering, consider the following articles:

 

How do the CMS API work?

The CMS API uses a single endpoint in Conductor Monitoring's Reporting v1 API. When you publish a new or edited page, you can send the URL in the request body to this endpoint to let Conductor Monitoring know that it should be prioritized for auditing.

Authentication

Get your CMS API integration token

To use the CMS API you need to get your Conductor Monitoring account's CMS API token. You'll find it in the Integration Tokens section under the Account tab in the main Account section.

contentking-retrieving-cms-api-token@2x.png

Configure your request headers

To authenticate your requests, you need to include the following request headers:

Authorization: token {Your-CSM-API-Token}
Content-Type: application/json

Note!

The value for the Authorization header must be the string "token" followed by a space and then your actual API token.

 

Using the CMS API

Prioritize a Page for Audit by Conductor Monitoring

https://api.contentkingapp.com/v1/check_url

Every time you make a change through your CMS, such as adding, deleting, or changing a page, you need your website to call the Conductor Monitoring API with a POST request to this endpoint.

Request Body

{
  "url": "https://www.example.com/url-to-check/"
}

Note!

Don't forget to include the domain name and protocol (http or https) in your request.

 

Responses

200

Successfully processed. The request was successfully processed and the page will be checked immediately.

Example

{
  "status" : "ok"
}
400

Bad Request:

  • Invalid URL. The URL is formatted incorrectly. Confirm that you sent a full URL, including the domain and protocol, not just the path
  • Unknown website. The website associated with the URL you sent doesn't exist in the Conductor Monitoring account belonging to the API token.

Examples

{
  "code": "invalid_url",
  "message": "Invalid url format provided.",
  "errors": []
                    }
{
                      "code": "unknown_website",
                      "message": "Website isn't registered in CK account.",
                      "errors": []
}
401

Unauthorized:

  • Missing token. The request was received, butit's lacking an authorization token and can therefore not be processed. Make sure to correctly set the Authorization header.
  • Failed. The request could not be processed because the supplied API token is invalid or expired.

Example

{
  "code": "auth_missing_token",
  "message": "Authentication token must be passed in Authorization HTTP header.",
  "errors": []
                    }
{
                      "code": "auth_failed",
                      "message": "Authentication token is expired or invalid.",
                      "errors": []
}
422

Authorization malformed. The request was received, but the authorization wasn't formatted correctly. Make sure to correctly set the Authorization header.

Example

{
  "code": "auth_malformed",
  "message": "Authorization HTTP header must conform to format described in docs.",
  "errors": []
}

Need some help with integrating the CMS API?

In case you or your developer need any help with integrating the API don't hesitate to reach out. We're always happy to help!