Commerce Connector Configuration for brX GraphQL Service

Introduction

As depicted in the Architecture Overview, GraphQL client applications, such as SPA or Open UI Pickers, should be able to communicate with the brX GraphQL Service.

GraphQL client applications may discover the URL of the brX GraphQL Service through the REST API for Commerce Connector Properties. That is, clients may read the apollo.server.url property of the associated Commerce Connector to find out the URL of the brX GraphQL Service.

Typical Flow with SPA in the Channel

As described in Configure Commerce Connector, a channel is configured with a specific Commerce Connector to let the SPA interact with the specific Commerce Backend Platform through the brX GraphQL Service. A typical flow looks like this:

• SPA reads the Channel properties ("$.channel.info.props" in JSONPath format) from the Page Model API response like the following:

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

• SPA reads the properties of the Commerce Connector, specified in the "defaultConnector" Channel property, through the REST API for Commerce Connector Properties to find out the URL of brX GraphQL Service.
• SPA interacts with the brX GraphQL Service to read or update data in the Commerce Backend Platform.

Typical Flow with Open UI Pickers

Using Open UI Pickers, authors or editors select a specific Commerce Connector and associated category, product, product variant or account in the document. A typical flow looks like this:

• An authors or editor edits a category, product or account detail document in CMS.
• The user selects a specific Commerce Connector.
• The user selects a specific category, product, product variant or account from the Commerce Backend Platform through the UI.
  • The Open UI Picker UI discovers the URL of the brX GraphQL Service through the REST API for Commerce Connector Properties.
  • It searches or resolves the resources through the GraphQL API set provided by the brX GraphQL Service.
  • It stores the selection in the document.
• The user saves, unpublishes, or publishes the document.