Commerce Connector Configuration for brX GraphQL Service

Info: This feature in Bloomreach Content requires a standard or premium license. Contact Bloomreach for licensing details.

Overview

GraphQL client applications, such as Single Page Applications (SPAs) or Open UI Pickers, interact with the brX GraphQL Service as described in the Architecture Overview.

These clients can determine the brX GraphQL Service URL by accessing the REST API for Commerce Connector Properties. Specifically, clients read the apollo.server.url property from the relevant Commerce Connector to obtain the service URL.

If your implementation uses only one Commerce Backend Platform, set the apollo.server.url property in the corresponding Commerce Connector document. For multi-channel environments, where each channel may use a different Commerce Backend Platform, configure the apollo.server.url property in each Commerce Connector document. Applications retrieve this property on a per-connector basis.

SPA Integration Flow

When a channel is configured with a specific Commerce Connector, the SPA communicates with the Commerce Backend Platform through the brX GraphQL Service. The process follows these steps:

1. The SPA reads channel properties from the Page Model API response. The relevant properties are found at "$.channel.info.props" (JSONPath).
   • Example response:

     {
       //...SNIP...
       "channel": {
         "info": {
           "props": {
             "defaultSMConnector": "brsm",
             "defaultConnector": "commercetools",
             "smViewId": "12345",
             //...
           },
           //...
         },
       },
       //...SNIP...
     }
     copy

2. The SPA uses the value of the "defaultConnector" property to identify the Commerce Connector.
3. The SPA retrieves the Commerce Connector properties, including the brX GraphQL Service URL, using the REST API for Commerce Connector Properties.
4. The SPA interacts with the brX GraphQL Service to read or update data in the Commerce Backend Platform.

Open UI Picker Integration Flow

When using Open UI Pickers, authors or editors select a Commerce Connector and related entities (category, product, product variant, or account) within a document. The flow is as follows:

1. An author or editor opens a category, product, or account detail document in the CMS.
2. The user selects a Commerce Connector.
3. The user selects a category, product, product variant, or account from the Commerce Backend Platform via the UI.
   • The Open UI Picker retrieves the brX GraphQL Service URL using the REST API for Commerce Connector Properties.
   • The picker searches or resolves resources through the GraphQL API provided by the brX GraphQL Service.
   • The selection is stored in the document.
4. The user saves, unpublishes, or publishes the document.