Articles in this section

Set up a connection to Bloomreach

Tanisha Ray
Updated

Bloomreach is a leading digital experience platform that helps businesses deliver personalized and optimized online experiences to their customers through AI-driven search, content management, and commerce solutions.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type * 

Choose your Bloomreach account API type:

  • Engagement: Track user behavior, manage customer data, and trigger personalized campaigns to deliver real-time, omnichannel marketing experiences that drive engagement and retention.

  • Content delivery: Retrieve pages, documents, and components via headless APIs to power fast, dynamic, and personalized digital experiences across websites and applications.

  • Content management: Create, update, and manage structured content, assets, and site configurations to streamline editorial workflows and automate content operations.

  • Discovery: Enable intelligent search, category navigation, and personalized product recommendations to boost product discoverability and conversion across eCommerce experiences.

API type: Engagement 

Base URL *

Enter your Bloomreach account base URL.

For example, if your API base URL is https://api-engagement.bloomreach.com, then https://api-engagement.bloomreach.com is your base URL. For more information, see Configure.

If a custom base URL is not available, https://api.exponea.com/ is your default base URL.

dataLoad.svg​​How to retrieve the API base URL

Project token * 

Enter your Bloomreach project token.

dataLoad.svg​​How to retrieve the project token 

Auth type * 

Select your Bloomreach authentication type (either Basic or Token).

API token * 

(This setting is only applicable with Token auth type)

Enter your Bloomreach public API token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​How to retrieve the public API token 

API key ID * 

Enter your Bloomreach private API key ID.

dataLoad.svg​​How to retrieve the private API key ID 

API secret * 

Enter your Bloomreach private API secret.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API secret safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​How to retrieve the API secret

API type: Content delivery 

Subdomain * 

Enter your Bloomreach account subdomain. For example, if your account URL is https://cloudapi.bloomreach.io/delivery , then cloudapi is your subdomain.

Token * 

Enter your Bloomreach content token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​How to retrieve the token 

API type: Content management 

Token * 

Enter your Bloomreach content token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​How to retrieve the token 

API type: Discovery 

Environment * 

Select your Bloomreach Discovery account environment (either Production or Sandbox).

Token * 

Enter your Bloomreach discovery token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

Job ID * 

Enter your Bloomreach job ID.

dataLoad.svg​​How to retrieve the job ID 

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see token, and basic universal connector documentation respectively.

How to retrieve the project token, API token, and API key

  1. Sign in to your Bloomreach account. 

  2. Navigate to Project settings > Access management > API > API groups.

  3. Copy the project token.

  4. Copy the Base URL.

  5. Click + New group.

  6. In the Access type, select Public access.

  7. Enter a Key name. 

  8. Click Create group.

  9. Copy the API token. For more information, see API groups.

  10. Copy the API key ID. 

  11. Copy the API secret.

How to retrieve the API base URL

  1. Sign in to your Bloomreach account. 

  2. Navigate to Project Settings > Access Management > API.

  3. Copy the API base URL.

How to retrieve the token

  1. Sign in to your Bloomreach Content account. 

  2. Navigate to Setup > brXM API token management.

  3. Click + API token.

  4. Enter a Token name, and select an Expiration date.

  5. Provide the Access and click Create.

  6. Copy the Token. For more information, see Instructions. 

How to retrieve the job ID

  1. Sign in to your Bloomreach Discovery account. 

  2. Navigate to Setup > Catalog management > Jobs.

  3. Search for the required job.

  4. Copy the Job ID. For more information, see Jobs. 

Additional references