Skip to main content
Skip table of contents

Bloomreach

Introduction

This guide explains how to obtain authentication details from Bloomreach, as well as installing a Bloomreach Connector.


Setup & Authentication

Remote Setup in Bloomreach - performed by your customer

Your customer should go to their Bloomreach account and do the following:

Get a base URL

Bloomreach’s documentation on how to find the base URL can be found here.

Get a project token

Bloomreach’s documentation on how to get a project token can be found here.

Create an API group with private API access

Bloomreach’s documentation on how create an API group with private API access can be found here.

Assign permissions to the API group

Bloomreach’s documentation on how to assign permissions to the API group can be found here. For full Connector functionality, add the following permissions:

  • Definitions > Get

  • Customer properties > Get

  • Events > "consent" Get

  • GDPR > Export customer

  • Events > Get

Cyclr Connector Installation

When installing the Bloomreach Connector, the following values are used:

Parameter

Description

API Key ID

The API key ID obtained from creating an API group with private API access.

API Secret

The API secret obtained from creating an API group with private API access.

Base URL

The URL of the Bloomreach instance. For example, https://api.exponea.com.

Project Token

The project token of the project to make requests against.


Additional Information

Hard Customer IDs

The default mapped hard customer ID field is registered. If your hard customer ID differs in name from this, you will need to map it as a custom request field. You can do this from the Edit Connector page:

  1. Under the Methods & Fields heading, select to expand the method category and method.

  2. Under the Request Fields heading, select the image-20240708-160945.png Add Method Field button.

  3. Set the Field Location to customer_ids.<HardId> where HardId is the value of your hard customer ID.

  4. Set the Data Type to Text.

  5. Optionally, set the Display Name and Description.

  6. Select Create.

The new hard customer ID will now be settable in Cycles.

Map response field properties

As response field properties are dynamic based on how your Bloomreach project is configured, you need to manually map them. This mapping is different per Connector method. Create the mapping from the Edit Connector page:

  1. Under the Methods & Fields heading, select to expand the method category and method.

  2. Under the Response Fields heading, select the image-20240708-160945.png Add Method Field button.

  3. Set the Field Location to the values below depending on the method where PropertyKey is the key of the property to be mapped:

Method

Field Location

Customers > Get Customer

properties.<PropertyKey>

Customers > Get Customer, events array

[events].properties.<PropertyKey>

Customers > Get Customer Attributes

<PropertyKey>

Customers > List Customers

[data].<PropertyKey>

Customers > List Events

[data].properties.<PropertyKey>

  1. Set the Data Type to Text.

  2. Optionally, set the Display Name and Description.

  3. Select Create.

The new property will now be mappable in Cycles.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.