Install the Content HAL API add-on
Bloomreach offers Enterprise support for this feature to Bloomreach Experience customers. The release cycle of this feature may differ from our core product release cycle.
Prerequisites
To be able to use the Content HAL API add-on, your implementation project must be set up as a Bloomreach Experience Manager project.
Instructions
Add Maven Dependency
In the main pom.xml of your project, add a new property in the properties section. For the correct version number for your project, check the Release Notes page.
<bloomreach.content-hal-api.version>version-number</bloomreach.content-hal-api.version>
Add the following dependency in the 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>
Since 3.0.0, the maven coordinates have been changed from com.onehippo.cms7:hippo-addon-content-hal-api-service to com.bloomreach.cms.content-hal-api:content-hal-api-service.
Configure Delivery Tier Mount
Add an API mount, with hst:namedpipeline = HalRestApiPipeline, like the following example (expressed 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]
After rebuilding the project and restarting the server, you will be able to test the built-in Content HAL APIs right way.
See API page and Examples page for details.