Skip to content

HCL Experience API

This shows developers how to provision, configure, and use the HCL Experience API with the HCL Digital Experience (DX) 9.5 platform.

Overview

The HCL Experience API is a set of REST APIs you can use to work with HCL DX 9.5. It supports the integration and management of HCL DX 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 DX HTTP-based APIs. However, note that not all REST APIs are OpenAPI-compliant.

See the HCL Digital Experience 8.5 and 9.0 topics for additional information about previously published HCL DX APIs.

Benefits of using HCL Experience API include:

  • OpenAPI compliance

  • GraphQL enabled for some of the Experience APIs

    Note

    The use of GraphQL functions is available at a beta level and is not yet supported for production use.

  • Simplified JSON payloads

  • Enhanced API documentation

The HCL Experience API provides simplified APIs to make it easier for developers to use. It also has human-readable request and response payloads in JSON format for easy request construction. The HCL Experience API allows users to send and receive requests via OpenAPI-compliant interfaces. This API set accepts form-encoded request bodies made over HTTPS, and returns JSON-encoded responses using standard HTTP response codes and verbs.

The HCL Experience API describes a high-level API through which the following specific APIs are exposed:

  • 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.
  • HCL Digital Asset Management API: Presents developer entry points to the Digital Asset Management (DAM) features of HCL DX 9.5.
  • HCL Image Processor API: Presents developer entry points to the DAM Image Processor functions of HCL DX 9.5.
  • HCL Personalization API: Presents developer entry points to the Personalization Rule functions of HCL DX 9.5.
  • 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.
  • HCL Access Control API: Presents developer entry points to the Access Control Management functions of HCL DX 9.5.
  • HCL Remote Model API: Presents developer entry points to the various models for pages, layouts, and more functions of HCL DX 9.5.
  • HCL Search API: Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5.
  • HCL Users and Groups API: Presents developer entry points to the user and group management functions of HCL DX 9.5.

Note

Future HCL DX 9.5 feature functionality will also be exposed through the HCL DX API.

It is recommended that developers building solutions for HCL DX 9.5 running on Kubernetes automatically use the HCL Experience API for the scenarios that are covered.

The HCL Experience API is a component of the HCL DX offerings. HCL DX offering license and download packages are provided with HCL Digital Experience entitlements available to customers on the My HCLSoftware (MHS) portal.

Note

Beginning with Container Update and CF196, additional Experience APIs are introduced, which support development of Web Content Manager functions.

Video: Using the Digital Experience V2 Web Content Manager APIs.

Installation instructions for HCL DX 9.5 image components may be viewed in the container deployment pages.

Detailed API listings for the HCL Experience API, and updates, may be viewed at the HCL Digital Experience GitHub repository.

  • Prerequisites
    The HCL Experience API requires software prerequisites to successfully run. The build package also includes this information, along with the installation and configuration steps.
  • Configuration options
    The HCL Experience API comes with a set of default configurations. The build package also includes this information, along with the installation steps.
  • Getting started with HCL Experience API
    Follow these steps to get started with the HCL Experience API.
  • Digital Experience REST API explorers
    This section shows the DX REST API explorers available for use with deployments to on-premises and container platforms.
  • DAM API for friendly URLs
    This section describes the DAM API that allows you to create a friendly URL for an asset.
  • Sample API calls
    To give users more insight on how to use Experience API, the following samples are provided.
  • Sample Content UI
    Learn how to use the Sample Content UI application for HCL Experience API.

HCLSoftware U learning materials

For an introduction and a demo on how to use Experience API, go to Experience API. To try it out yourself, refer to Experience API Lab and corresponding Experience API Lab Resources.

Related information