Introduction
The Content Management API can be used to get, create and update a single document, page or resource bundle at a time.
Development project scope
All operations are performed within the context of a developer project, and all writes are performed on an unpublished variant of a page or document associated with the project.
Authorization
The Content 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 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
Developer tools
To aid developers in working and learning the Content Management API, the following tools and resources are provided:
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 button
Easily fork the Content 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.
The only thing needed to use the Postman collection is to setup the environment variables:
brxHost: the URL of your Bloomreach Content environmentx-auth-token: the Authentication token
Swagger UI
It's possible to trigger API requests requests directly to a Bloomreach Content environment using the Swagger UI. Via the below URL, explore and try out the Content Management API:
https://<your_brx_host>.bloomreach.io/management/content/v1/api-docs