As part of Bloomreach integration, you need to send your catalog data to Bloomreach. For an overview of the integration process, refer to Milestone 3.
Product Catalog
To integrate Bloomreach product 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 product record, which contains the data for a single product. We also provide details on how to implement variants and/or views, if your catalog uses them.
- Products
- Variants
- Views
- Variants and 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: Configure Attributes
You can configure your product catalog data attributes such as title, description, price, sku, etc. so that Bloomreach processes your data the way you need it. Work with your Bloomreach representative to configure the required attributes.
Step 4. Publish the index
You must publish the index in order to query your catalogs with our Search APIs. Make sure to deploy the Product Search API .
Content Catalog
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 an 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: Configure Attributes
You can configure your product catalog data attributes such as title, description, etc. so that Bloomreach processes your data the way you need it. Work with your Bloomreach representative to configure the required attributes.
Step 4. Publish the index
You must publish the index in order to query your catalogs with our Search APIs. Make sure to deploy the Content Search API.
Run in Postman
Easily import the Discovery API collection and try the endpoints in Postman. It offers many examples of how the endpoints can be used for different use-cases.
The only thing needed to use the Postman collection is to set up the environment variables:
| Environment Variable | Value |
|---|---|
| host | Indexing Host |
| account_id | Your Bloomreach provided account ID |
| domain_key | Where this information will be stored on the backend represented with catalog name and language key |
| collection | Content Catalog |
| key | An API key will be provided for each environment in your account. This access key must be placed in the Authorization header. |
| search_host | Search Host |
| auto_suggest_host | Auto-suggest Host |
| url | The absolute URL of the page where the request is initiated. Do not use a relative URL |
| ref_url | The URL of the page or HTTP referrer where the request is started |
| br_uid_2 | The br_uid_2 cookie is a first-party cookie created by the Bloomreach tracking pixel library |
| request_id | An ID to track site visitor clicks. We recommend you generate unique random values of 13 digits to enable click-tracking |