CKEditor Ecosystem Documentation
Search
Home/Cloud Services/FAQ

guideGlossary

# Organization

Every customer who uses any services from CKSource has its own ID. It is called OrganizationId.
A single organization can have multiple environments.

# Environment

An environment introduces a logical separation of customer data. Every environment has a separate key which is used to encrypt its data.

# Access Key

An Access Key is a key used to generate signed tokens.
It can be generated in the Dashboard (for SaaS) or in the Management Panel (for On-Premises).

# API Secret

An API secret is a secret used to generate a signature for requests made to the REST API.
It can be found in a Dashboard (for SaaS) or in a Management Panel (for On-Premises).

# Token

It is used to authorize customers during communication between CKE5 and CKEditor Collaboration Services.
It includes data about the user and their privileges in the context of the document.
It has to be returned from a Token Endpoint created by the customer.

# Token endpoint

An endpoint created by a customer which returns token. For more information you can check the dedicated section.

# Dashboard

A place where customers can manage their existing license subscriptions and products.

On-Premises subscribers will find there credentials needed to pull Docker images and license keys for the applications.

For SaaS users, it also provides a panel for managing Environments, Access Keys, API Secrets, etc. On-Premises users can access this panel via the Management Panel for On-Premises.

# Management Panel

This is where On-Premises users can manage their Environments, Access Keys, API Secrets, etc.
It can be found under the /panel path on the server where CKEditor Collaboration Server On-Premises is running.

# Collaborative Session

When a user creates a new document, a collaborative session is initiated. It provides a space where all temporary data related to a document is stored.

# Bundle version

The bundle version is set during the collaboration session initialization. Depending on the way you are initializing such a session, it will be taken either the from REST API request or from the editor configuration:

  • if you import the document data using the REST API, it will use the value passed in the bundle_version field in the request body,
  • if you initialize the collaboration session by connecting to the document via the editor, it will use the value from the editor config (cloudServices.bundleVersion). If no value is passed in the editor config, it will default to the editor version (e.g. 34.0.0).