CCMS API Overview
The Heretto CCMS API (v2) enables programmatic access to publishing and deployment operations within the Heretto Component Content Management System (CCMS). This REST API enables you to automate publishing workflows, manage deployments, retrieve publishing outputs, and configure publishing scenarios.
This is an Alpha release of the CCMS API v2 that focuses on publishing capabilities. Additional endpoints will be added as they become available. We welcome your feedback, which you can share using the Was this helpful? feature at the bottom of each page in this portal.
The Heretto CCMS API is designed to support various automation and integration scenarios:
- CI/CD pipeline integration
- Automate content publishing as part of your continuous integration and deployment workflows.
- Custom publishing dashboards
- Build internal tools to monitor publishing operations and deployment status.
- Scheduled publishing
- Trigger publishing jobs automatically based on schedules or external events.
- Multi-locale management
- Programmatically manage content deployments across multiple languages and regions.
- Audit and compliance
- Track and report on publishing history for regulatory requirements.
This API enables you to work with these CCMS interfaces:
- Deployments
- Work with preconfigured deployments in the CCMS to manage content publishing from the CCMS to Heretto Portal or other delivery endpoints such as websites, applications, devices, or machines.
- Publishing jobs
- Manage CCMS content publishing to static outputs, like PDF or HTML, by using publishing engines like PDF Generator or DITA Open Toolkit (DITA-OT).
- Publishing scenarios
- Retrieve available scenarios and their configurable parameters, which you can then use when creating publishing jobs.
- Releases
- Retrieve information about existing releases (snapshots of content).
Authentication
The Heretto CCMS API supports two authentication methods:
- Basic Authentication
-
Include an
Authorizationheader with the valueBasic <base64(username:password)>in your API requests. You can use your CCMS username and either your password or an API token generated in the CCMS. - SSO Cookie Authentication
-
Include the
JSESSIONIDcookie from your authenticated browser session. This method is useful when testing the API from this documentation site or integrating with browser-based tools that maintain SSO sessions.
For more information, see CCMS API Authentication.
Base URL
All API requests use this base URL structure:
https://{organizationId}.heretto.com/ezdnxtgen/apiWhere {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.
Important Considerations
-
The Heretto CCMS API doesn't support bulk updates. You can work on only one object per request.
-
The 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, andnumberOfElementsto help you implement pagination controls.