Introduction to the API

Welcome to the API documentation! This API allows you to interact with various content and services available within the system. Through the API, you can perform actions such as:

• User Authentication: Authenticate users and obtain a token for further API calls.
• Content Querying and Management: Retrieve lists of articles or other content, view specific content, and search based on various filters.
• Engagement: Like articles, comment on them, and view comment threads.
• Revenue: Handle purchases and payments, including for third-party platforms like iTunes or Google Play.
• Reporting: Fetch the most-read, most-commented, or most-shared articles.

Authentication

There are two levels of authentication required for using the API. Refer to the Authentication page.

Caching and Swagger support

Most GET endpoints support built-in caching operated by the CMS. Cache is invalidated when needed. This mechanism is fully handled by the CMS.

HTTP Requests

All requests are made using either the POST or GET or DELETE methods, depending on the endpoint. The request parameters should be passed using application/x-www-form-urlencoded or as multipart/form-data or as application/json. Make sure your Content-Type header is therefore properly set. We recommend using application/json.

For requests with file uploads, use multipart/form-data.

Response Formats

By default, responses are provided in JSON format, which includes detailed information about the requested data, status, and error messages (if applicable). In some cases, the API can return XML responses, especially when content is requested in specific formats like RSS, Atom, or Facebook Catalog.

Example response:

{
  "error": false,
  "data": {
    "id": 123,
    "title": "Sample Article",
    "summary": "This is a summary of the article.",
    "url": "https://example.com/article/123"
  }
}

In case of errors, the response status code will be equal to something other than 200. Usually, it will contain more information about the error:

{
  "error": true,
  "message": "Invalid API key or token",
  "error_type": "Unauthorized"
}

URL Format

All API endpoints follow a consistent URL format. The base URL for accessing the API is structured as follows:

https://api.{your_domain}/cms/{path}

Questions and Support

If you have any questions about using the API or run into any issues, feel free to reach out to our support team on support@whitebeard.nl. We’re here to help you get the most out of the API and ensure a smooth integration experience!