CCMS API Endpoint Specification

The Heretto CCMS API is organized around REST, using resource-oriented URLs and JSON. It supports pagination, URL-based versioning, and includes endpoints for deployments, publishing jobs, scenarios, and releases.

The CCMS API is organized around REST. The API has resource-oriented URLs, accepts JSON-encoded requests and returns JSON-encoded responses. The API uses standard HTTP authentication, response codes, and methods.

You can test Heretto CCMS API directly from the help site (example). By default, the help site demonstrates using cURL to interact with the API over HTTP. Specify a programming language to see examples in code.

Use your CCMS username and a token (or password) you generate in the CCMS to authenticate.

The Heretto CCMS API doesn't support bulk updates. You can work on only one object per request.

The Heretto CCMS API supports pagination for endpoints that return large result sets, such as publishing history and scenario listings. Use the page (zero-indexed) and size (default: 20, maximum: 100) query parameters to navigate through results. Responses include metadata such as totalPages, totalElements, and numberOfElements to help you implement pagination controls.

Base URL

All API requests use this base URL structure:

JSON 
https://{organizationId}.heretto.com/ezdnxtgen/api

Where {organizationId} is the subdomain you use to access Heretto CCMS. For example, if you access Heretto CCMS at https://thunderbird.heretto.com, use thunderbird as the organizationId.

API Versioning

The Heretto CCMS API uses URL-based versioning. The current version is v2, indicated in the endpoint paths (for example, /v2/deployments).

API Organization

The Heretto CCMS API publishing capabilities are grouped in these categories:

Deployments

A configuration in Heretto CCMS that enables publishing content from Heretto CCMS to Heretto Portal or other delivery endpoints such as websites, applications, devices, or machines. Deployments publish content associated with a specific sitemap and carry information about deployment type, locales, and audiences. Deployments enable dynamic, scalable content transformation to a help site or other endpoints.

Endpoints grouped under the Deployments category enable you to work with pre-configured deployments in Heretto CCMS.

Publishing Jobs

A processing operation that transforms Heretto CCMS content (a DITA topic or map) into published output according to a specified scenario. Publishing jobs generate static, file-based outputs, such as PDF or HTML, by using processing engines like PDF Generator or DITA Open Toolkit (DITA-OT).

Endpoints grouped under the Publishing Job categories (Publishing Jobs, Publishing Scenarios) enable you to initiate publishing jobs, monitor their progress, and retrieve published assets.

Important:

Publishing job endpoints are file-oriented, meaning you can obtain publishing details for a specific file, such as a DITA map or topic. To access these details, provide the file identifier (fileId parameter), which you can retrieve from the CCMS interface by following Get a Resource UUID.

Publishing Scenarios

Pre-configured transformation settings that define the output format, processing engine (such as PDF Generator or DITA Open Toolkit (DITA-OT)), and transformation parameters used during publishing jobs. Each scenario includes customizable parameters that control the publishing process, such as output type, filtering options, and formatting settings.

Endpoints grouped under the Publishing Scenarios category enable you to retrieve available scenarios and their configurable parameters, which you can then use when creating publishing jobs.

Releases

Snapshots of content at specific points in time that enable version control and historical tracking. Endpoints grouped under the Releases category enable you to retrieve information about existing releases.