Deploy API serves as an interface to transform and deliver your content from Heretto CCMS for consumption by Heretto Portal as well as external platforms, including websites, mobile applications, Software as a Service (SaaS) applications, and embedded systems within kiosks, devices, or machines. Deploy API supports delivering localized content, managing access through authentication, and tailoring content to different audiences (personalization).

For example, the documentation you are currently reading was delivered to this help site with Deploy API. Our help site is powered by both Deploy API and Heretto Portal.

Selected Deploy API use cases:

Building Websites

With Deploy API, you can use your content in Heretto CCMS to build knowledge bases, support sites, or any other websites. You can brand, modify, and seamlessly integrate websites you build into your existing web assets to provide a consistent look and feel.

Embedding Content

Use Deploy API to embed content from Heretto CCMS into an existing website or web application. For example, you can embed a help site directly into your company website or use the content for context-sensitive help.

Content from a Single Source

Deploy API enables the use of the same DITA source files for different types of deliverables. Editing a single DITA source can update multiple assets.

Definitions

Heretto Deploy API

A read-only API that enables you to deliver content from Heretto CCMS to different endpoints. The delivered content includes:

• JSON data
• Media files
• Transformed XML content (HTML5) or compiled DITA

Sitemaps

Sitemaps are specialized DITA maps that determine the structure of your content. Depending on the environment you publish to, you may need to use different sitemap structures.

Deploy API supports different sitemap structures.