Site Management API

Introduction

The Site Management API enables Bloomreach Content developers to manage channel configurations through a set of endpoints for operations on channels, layouts, components, routes, and menus.

API Base URL

https://<your_brx_host>.bloomreach.io/management/site/v1

Authorization

The Site Management API is a protected management API and requires authorization using a token. See API Authorization for instructions on how to obtain and use a token.

Updates and conflict prevention

When updating an existing site configuration 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.

Reference

Development Aids

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

Site Development App

The Bloomreach Content UI includes the Site development app, a GUI layer on top of the Site Management API. Read more about how to configure your site.

12801280

Public Environment

In case you don't yet have access to a Bloomreach environment, you can easily Log in to the Public Developer Environment. Follow the instructions to retrieve an authentication token and easily explore the APIs.

Run in Postman

Easily import the Site Management API collection and try the endpoints in Postman . The advantage is that in Postman we offer many examples of how the endpoints can be used.

Run in PostmanRun in Postman

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

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

Swagger UI

Your Bloomreach Content environment provides an interactive Swagger UI for exploring and trying out the Site Management API at the following URL:

https://<your_brx_host>.bloomreach.io/management/site/v1/api-docs