API Based Catalog Data Delivery (Content) - Bloomreach Experience - Open Source CMS

API Based Catalog Data Delivery (Content)

Integration Overview

To integrate Bloomreach content search via API feed ingestion, follow the steps given below. 

Step 1. Format your data

You must format your catalog data properly in order for Bloomreach to ingest it. In this step, you will learn how to format a item record, which contains the data for a single content item. We also provide details on how to implement views, if your catalog uses them.

  • Sample Feed

  • Attributes

  • Views

Step 2. Send your data

After properly formatting your catalog data, you must send it to Bloomreach for ingestion. There are two modes of delivery:

  • PUT (full replacement of catalog data)
  • PATCH (partial updates to catalog data) 

Catalog data may be sent as an API payload, or as a file sent to a SFTP.

Step 3. Update the index

You must update the index in order to query your catalogs with our Search APIs. Make sure to deploy the Content Search API.

Step 4: Configure Attributes

In the final step, you can configure your content catalog data attributes such as title, description, etc. so that Bloomreach processes your data the way you need it. In the Beta version, work with your Bloomreach representative to configure the required attributes. 

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?