Expose RESTful Web Services: Overview
Overview
This page summarizes the available options for exposing Bloomreach Content content and content management functionality through RESTful web services.
Purpose
You can use RESTful web services to access content stored in the repository and to interact with content management features in Bloomreach Content. The platform provides several mechanisms to expose REST APIs, each suited to different use cases.
Available Mechanisms
- Content REST API
The Content REST API is a generic REST interface on the delivery tier. It automatically exposes all published content in the repository, based on defined document types. - Custom JAX-RS Services
If the Content REST API does not meet your requirements, you can implement custom services using JAX-RS support in the delivery tier. There are two types:- Context-aware JAX-RS services: Dynamically expose site content mapped to content types.
- Plain JAX-RS services: Expose preconfigured site functionality not directly mapped to content, but able to interact with it.
- Repository JAX-RS services
Use these services to expose REST APIs that interact with internal CMS components, such as repository-managed daemon modules. - Delivery API
The Delivery API exposes Experience Manager functionality and the HST page model through JSON REST APIs. This enables integration with single-page application (SPA) frameworks.
Feature Comparison
| Provided by | Page Context | Channel Context | Document Context | Access Unpublished Content | Customizable | |
|---|---|---|---|---|---|---|
| Content REST API | Delivery | Warning: no | Hint: yes | Hint: yes | Warning: no | Warning: no |
| Context-aware services | Delivery | Warning: no | Hint: yes | Hint: yes | Hint: yes | Hint: yes |
| Plain JAX-RS services | Delivery | Warning: no | Hint: yes | Hint: yes | Hint: yes | Hint: yes |
| Repository JAX-RS services | Repository | Warning: no | Warning: no | Warning: no | Warning: no | Hint: yes |
| Delivery API | Delivery | Hint: yes | Hint: yes | Hint: yes | Hint: yes | Warning: no |
Note: The Essentials setup application includes a REST Services Setup tool that helps you configure the Content REST API and custom plain JAX-RS services.
Note: For additional capabilities, see the Content HAL API Services Plugin.