https://github.com/hcl-tech-software/experience-api-documentation

HCL DX Experience API Documentation for HCL Ring API, HCL Digital Asset Management API, HCL Image Processor
https://github.com/hcl-tech-software/experience-api-documentation

dam hcl-dx image-processor ringapi

Last synced: 16 days ago
JSON representation

HCL DX Experience API Documentation for HCL Ring API, HCL Digital Asset Management API, HCL Image Processor

• Host: GitHub
• URL: https://github.com/hcl-tech-software/experience-api-documentation
• Owner: HCL-TECH-SOFTWARE
• License: apache-2.0
• Created: 2020-08-24T08:22:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-09-24T20:46:20.000Z (5 months ago)
• Last Synced: 2025-10-02T07:29:49.074Z (4 months ago)
• Topics: dam, hcl-dx, image-processor, ringapi
• Language: HTML
• Homepage:
• Size: 3.05 MB
• Stars: 2
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# HCL Experience API Documentation

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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api)             | Presents developer entry points to the Personalization Rule functions of HCL DX 9.5.                                                                                                   | /dx/api/pzn/v1/explorer             |

| [**_HCL WCM API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/access-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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api)                   | 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_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-v2-api)                   | Presents new search capabilities powered by OpenSearch of HCL DX 9.5. | /dx/api/search/v2/explorer             |

| [**_HCL Users and Groups API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api)                   | Presents developer entry points to the user and group management functions of HCL DX 9.5.  | /dx/api/users/v1/explorer             |

| [**_HCL People Service API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/people-service-api)                   | Presents developer entrypoints to the People API features of HCL DX 9.5.  | /dx/api/people/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. 

## Reference urls

| 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 |

| HCL People Service API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/people-service-api |