Delivery API - Bloomreach Experience - Headless Digital Experience Platform

Delivery API

Introduction

The Delivery API provides RESTs endpoint for SPAs to retrieve JSON representations of:

  • A list of available channels
  • Pages in a channel including all the components, content items, and menus of which those pages are comprised
  • A specific document in the context of a channel

Following the core principles of HATEOAS, the SPA enters the REST application through a brX navigational URL and discovers all possible future client interactions within the resource representations returned from the server.

Additionally, the Delivery API provides seamless integration with the channel preview and page management features of the Experience manager in brX.

API base URL

https://<environment_name>.bloomreach.io/delivery/site/v1/

Authentication

When accessing the Delivery API through a live endpoint, by default it will return a channel's published pages and content. In order to access unpublished pages and content and render the channel preview in the Experience manager, an external frontend application must authenticate using a JSON Web Token.

API status and versions

You can check the health status and available versions of the API at the following URL:

https://<environment_name>.bloomreach.io/delivery/site/

If there is at least one channel with a Delivery API live, you'll receive a 200 response with a body like the following example:

{
  "status" : 200,
  "message" : "OK",
  "apiVersions" : [ "v1" ]
}

If no Delivery API is available for any channel, you'll receive a 404 response.

Reference

 

 

 

 

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?