Content Integrations Management API

Introduction

The Content Integrations Management API enables Bloomreach Content developers to manage UI extensions and Customer Data Platform integrations in a running Bloomreach Content environment.

UI extensions can be Custom integrations with 3rd party software to augment the content editing experience or out-of-the-box integrations provided by Bloomreach.

CDP integrations enable segment-based content personalization through integration with Bloomreach Engagement, allowing personalization of content for specific customer segments.

🚧

We are still working on adding the API reference for CDP integration management endpoints.

API base URL

https://<your_brx_host>.bloomreach.io/management/integrations/ui-extensions/v1

Authorization

The Content Integrations Management API is protected and requires authorization using a token. See API Authorization for instructions on obtaining and using a token. A token for the Content Integrations Management API can only be obtained by users who also have the IAM Role 'Site Admin'.

Updates and conflict prevention

When updating an existing project resource, you must include the entire resource, including all its existing unchanged properties. It's not possible to update only a subset of properties. Read more about how to handle updates and conflict prevention.

API reference

Development aids

To aid developers in working with the Content Integrations Management API, the following tools and resources are provided:

Public environment

If you don't have access to a Bloomreach Content environment yet, you can use the Public Developer Environment. Follow the instructions to retrieve an authentication token and explore the APIs.

Run in Postman

Import the Content Integrations Management API collection and try the endpoints in Postman. The collection provides many examples of how the endpoints can be used.

Run in Postman

The only thing needed to use the Postman collection is to set up the environment variables:

  • brxHost: the URL of your Bloomreach Content environment
  • x-auth-token: the authentication token