Site Management API
The Site Management API enables brX developers to manage channel configurations through a set of endpoints for operations on channels, layouts, components, routes, and menus.
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.
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.
Additionally, you must specify the resource's current version using the X-Resource-Version HTTP header. This version is compared with the current version to prevent a client from overwriting a resource that has been updated since the specified version was retrieved. If the version doesn't match, the update will be rejected.
To prevent any unexpected changes or conflicts, always update resources in the following order:
- Fetch the current resource along with its current version number.
- Update the resource by passing the changed resource along with its current version number.
- Channel Operations
- Channel Component Operations
- Channel Layout Operations
- Channel Route Operations
- Channel Menu Operations
To aid developers in working with the Site Management API, the following tools and resources are provided:
Your brX environment provides an interactive Swagger UI for exploring and trying out the Site Management API at the following URL:
Bloomreach provides a Postman collection for the Site Management API in order to make working with the API easier for developers.