Install the Content HAL API Add-on

Info: Bloomreach provides Enterprise support for this feature to Bloomreach Experience customers. The release cycle for this add-on may differ from the core product release cycle.

Prerequisites

You must set up your project as a Bloomreach Content project before installing the Content HAL API add-on.

Installation Steps

1. Add the Maven Dependency

In your project's main pom.xml, add a property for the Content HAL API version in the properties section. Refer to the Release Notes to determine the correct version for your project.

<bloomreach.content-hal-api.version>version-number</bloomreach.content-hal-api.version>
copy

Next, add the dependency to site/components/pom.xml:

<dependency>
  <groupId>com.bloomreach.cms.content-hal-api</groupId>
  <artifactId>content-hal-api-service</artifactId>
  <version>${bloomreach.content-hal-api.version}</version>
</dependency>
copy

2. Configure the Delivery Tier Mount

Define an API mount with hst:namedpipeline set to HalRestApiPipeline. Use the following example in YAML format:

/hst:hst/hst:hosts/dev-localhost/localhost/hst:root/api:
  jcr:primaryType: hst:mount
  hst:alias: api
  hst:ismapped: false
  hst:mountsite: site
  hst:namedpipeline: HalRestApiPipeline
  hst:types: [rest]
copy

3. Rebuild and Restart

Rebuild your project and restart the server to apply the changes.

Verification

After restarting, you can access the built-in Content HAL APIs. For endpoint details and usage examples, see the API documentation and Examples.