guideRESTful APIs - overview

CKEditor Cloud Services offer several REST APIs that can be used for server integration.

The APIs currently include:

  • CKEditor Cloud Services REST APIs – Provides full-featured RESTful API that you can use to create a server-to-server integration.
  • HTML to PDF Converter API – Provides an API for converting HTML/CSS documents to the PDF format.
  • HTML to DOCX Converter API – Provides an API for converting HTML documents to Microsoft Word .docx files.

# Usage

Each method can be used for different purposes. For example, the REST API methods 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 methods is getting the content of the document from collaborative editing session. 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.

# 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

# CKEditor Cloud Services REST APIs

The API documentation is vailable here: https://help.cke-cs.com/api/docs/. It is an aggregator of all REST APIs currently available.

# HTML to PDF Converter API

The API documentation is vailable here: https://pdf-converter.cke-cs.com/docs.

Read more about this service in the Export to PDF guide.

# HTML to DOCX Converter API

The API documentation is vailable here: https://docx-converter.cke-cs.com/docs.

Read more about this service in the Export to Word guide.