Install the Content HAL API add-on - BloomReach Experience - Open Source CMS
08-08-2019

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.
Since 3.1.0, the above dependency brings in two taxonomy plugin related jars. If your project does not use the taxonomy plugin, it's possible to exclude those by inserting this below the <dependency> element:
<exclusions>
  <exclusion>
    <groupId>org.onehippo.cms7</groupId>
    <artifactId>hippo-plugin-taxonomy-api</artifactId>
  </exclusion>
  <exclusion>
    <groupId>org.onehippo.cms7</groupId>
    <artifactId>hippo-plugin-taxonomy-hst-api</artifactId>
  </exclusion>
</exclusions>

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.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?