REST API and Webhooks
# Cloud Services RESTful APIs
CKEditor Cloud Services offer several REST APIs that can be used for server integration. They provide a lot of powerful methods that make it possible to control and manage data. They can be used to control content revisions, handle users or manage document conversions.
The APIs currently include:
- CKEditor Cloud Services Restful APIs – Provides a full-featured RESTful API that you can use to create a server-to-server integration. The API documentation is available at https://help.cke-cs.com/api/docs/. It is an aggregator of all Restful APIs currently available.
- CKBox Restful API – Provides an API for managing data stored in the CKBox. The API documentation is available at https://api.ckbox.io/api/docs.
- HTML to PDF Converter API – Provides an API for converting HTML/CSS documents to PDF format. The API documentation is available at https://pdf-converter.cke-cs.com/docs.
- HTML to DOCX Converter API – Provides an API for converting HTML documents to Microsoft Word
.docxfiles. The API documentation is available at https://docx-converter.cke-cs.com/docs#section/Export-to-Word - DOCX to HTML Converter API – Provides an API for converting Microsoft Word
.docx/.dotxfiles to HTML documents. The API documentation is available at https://docx-converter.cke-cs.com/docs#section/Import-from-Word.
# Usage
Each method can be used for different purposes. For example, the REST API methods for comments allow 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 method is getting the content of the document from a collaborative editing session. This feature can be used to build an autosave mechanism for the document, which should reduce transfer costs – autosave requests are not executed by each connected user but only by the system once at a time.
When using REST APIs, data can be removed or modified via DELETE or PUT/PATCH methods. These operations cannot be reversed.
# Webhooks
Webhooks resemble a notification mechanism that can be used to build integrations with CKEditor Cloud Services. CKEditor Cloud Services sends an HTTP POST request to a configured URL when specified events are triggered.
Webhooks can be used for data synchronization between CKEditor Cloud Services and another system or to build a notifications system. For example, thanks to webhooks, the system might notify the users via email about changes made in the document.
To learn more about CKEditor Environment webhooks, refer to the Webhooks guide in the Cloud Services documentation.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.