guideAPI Explorer

Every service in CKEditor Cloud Services 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.

You can find the API Explorers in the documentation of each cloud service.

# Quick start

Organization ID, environment ID and API secret are required to test endpoints with the API Explorer. They can be found in the CKEditor Ecosystem customer dashboard in the API configuration section.

API configuration dialog of CKEditor Cloud Services.

The organization ID and environment ID should be provided in the API explorer to generate a correct API URL for a specific organization and environment. The example below shows the generator for the comments API.

Server variables in CKEditor Cloud Services.

In order to be able to communicate with the REST API for a specific organization and environment, each request must be signed using the API secret. The API secret should be provided in the dialog available after clicking the “Authorize” button.

The authorization process.

After the authorization, a specific endpoint can be tested by clicking the “Try it out” button.

“Try it out” button for testing an endpoint in CKEditor Cloud Services.

After giving the parameters, you can send a request by clicking the “Execute” button.

“Execute” button for testing an endpoint in CKEditor Cloud Services.

The response from the endpoint is presented below.

API response from an endpoint in CKEditor Cloud Services.