guideOverview

CKEditor Cloud Services provides full-featured Restful APIs that you can use to create a server-to-server integration.

Each API can be used for different purposes. For example, the REST API for comments allows for synchronizing comments between CKEditor Cloud Services and another system. In addition to that, CKEditor Cloud Services can be used as a database for comments because it is possible to download them via the REST API at the time they are being displayed.

An example of using another API is getting the content of the document via the Collaboration REST API. This feature can be used to build an auto-save mechanism for the document, which should reduce transfer costs — auto-save requests are not executed by each connected user but only by the system once at the time.

# Information

CKEditor Cloud Services REST APIs provide a lot of powerful methods that make it possible to control and manage data.

When using REST APIs, your data can be removed or modified. These operations cannot be reversed.

# Authentication

CKEditor Cloud Services REST APIs use HMAC Authentication. It means that every request must include a signature and a timestamp.

More information about signing a request is available in the Request signature guide.

# API Explorer

Every service provides an API Explorer. The API Explorer presents all versions of the documentation, updated automatically, and includes a useful tool for exploring and testing endpoints.

More information on how to use the API Explorer can be found in the API Explorer guide.

# Testing

Each REST API provides a handy tool for exploring and testing endpoints. However, to make it possible, it must be performed within the context of an environment and must be authorized. For this purpose, the API secret, the organization ID and the environment ID are required.

Instructions on how to get the API secret can be found in the API secret guide.

# Errors

Each error has the following fields:

  • message – It contains a short error description.
  • status_code – It contains the response status.
  • trace_id – It is a unique request identifier.
  • data – It may contain different information and may have a different structure depending on the endpoint.

# Example

You can find an example of an error below.

{
  "message": "Validation failed.",
  "traceId": "e5abd738-db35-4372-b1de-cff9b48cc311",
  "statusCode": 400,
  "data": {
    "messages": [
      "Environment ID must be at least 20 characters."
    ]
  }
}

# Documentation

Public documentation of CKEditor Cloud Services REST APIs is available here: https://help.cke-cs.com/api/v1/docs/. It is an aggregator of all REST APIs currently available.