The HCL Experience API is a set of OpenAPI compliant REST APIs available for customers deploying HCL Digital Experience 9.5 containers on supported Kubernetes platforms. It supports the integration and management of HCL Digital Experience content and functionality to any digital channel using any front-end development framework. The HCL Experience API includes REST APIs that serve as a wrapper around previously published HCL Digital Experience HTTP based APIs. The Experience API describes a high-level API through which the following specific APIs are exposed. Please refer to the individual links for the latest APIs and updates.
HCL Experience API
| Name | Description | Live API Explorer URL |
|---|---|---|
| HCL Ring API | Presents developer entry points to HCL DX 9.5 core platform capabilities which are divided into two main categories: Authorization APIs and Web Content APIs. | /dx/api/core/v1/explorer |
| HCL Digital Asset Management API | Presents developer entry points to the Digital Asset Management features of HCL DX 9.5. | /dx/api/dam/v1/explorer |
| HCL Image Processor API | Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX 9.5. | /dx/api/image-processor/v1/explorer |
| HCL Personalization API | Presents developer entry points to the Personalization Rule functions of HCL DX 9.5. | /dx/api/pzn/v1/explorer |
| HCL WCM API | Presents redesigned developer entry points to the Web Content Manager functions of HCL DX 9.5. Intended to facilitate the management of Web content, content-sites, and content-pages. | /dx/api/wcm/v2/explorer |
| HCL Access Control API | Presents developer entry points to the Access Control Management functions of HCL DX 9.5. | /dx/api/access/v1/explorer |
| HCL Remote Model API | Presents developer entry points to the various models for pages, layouts, and more functions of HCL DX 9.5. | /dx/api/remotemodel/v1/explorer |
| HCL Search API v1 | Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. | /dx/api/search/v1/explorer |
| HCL Search API v2 | Presents new search capabilities powered by OpenSearch of HCL DX 9.5. | /dx/api/search/v2/explorer |
| HCL Users and Groups API | Presents developer entry points to the user and group management functions of HCL DX 9.5. | /dx/api/users/v1/explorer |
Note : Future HCL DX 9.5 feature functionality will also be exposed through the HCL Experience API.
It is recommended that developers building solutions for HCL Digital Experience 9.5 running on Kubernetes programmatically use the HCL Experience API for the scenarios that are covered.
The HCL Experience API is a component of the HCL Digital Experience offerings. HCL Digital Experience offering license and download packages are provided with HCL Digital Experience entitlements available to customers on the HCL Software License Portal. https://www.hcltech.com/software/support/release
| Documentation | URL Specification |
|---|---|
| HCL Ring API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api |
| HCL Digital Asset Management API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api |
| HCL Image Processor API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api |
| HCL Personalization API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api |
| HCL WCM API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api |
| HCL Access Control API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/access-api |
| HCL Remote Model API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api |
| HCL Search API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api |
| HCL Users and Groups API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api |