Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This document provides the key information about how to set-up a standard integration of the first line of Boxalino Touch Point Widget & Page Optimizers (TPOsWPOs) : Welcome, Search, Up-Sell, Cross-Sell & Re-buy.

These TPOs WPOs are the typical TPOs WPOs to start with a correspond to the level 1 of the TPO WPO matrix:

...

In this document, we discuss a typical API integration which can be done in any programming language in any e-shop system (if you use Shopware or Magento, please contact Boxalino for the specific material for these e-shops).

...

In case of a column layout (e.g.: search filters on the left), a parameter “position” is provided with a target container value (e.g.: “left”) in some of the first level blocks. You can then simply take the list of main blocks with different position to integrate the Narrative blocks to the different containers of your page (the left position will be exemplified in the examples about the Search TPO WPO below).

Info

The complete request and response JSON structure are fully described in the document : “Narrative API - Technical Reference”.

...

  1. Make sure it is easy to parametrize the key parameters for multiple cases, mainly:

    1. widget (name of the TPO WPO instance : search, navigation, product recos, …)

    2. language (de, fr, en, …)

    3. hitCounts (how many products should be returned in the layout)

    4. offset / sort / selected facets (for search and navigation)

  2. Pass the correct sessionId and profileId in your request (the sessionId and the profileId should match the value of the cems and cemv cookies which are automatically set by our tracker, if they are not set yet, you need to create them (unique strings) and save them in the cookies)

  3. Pass the profileId also as a URL parameter to the endPoint (see Test your request to Boxalino Narrative API below)

  4. Create a connection pool with Curl (to avoid recreating the connection every time)

  5. Implement an automatic fall-back on the fall-back domain in case the main service is not responsive

  6. If some data cannot be returned directly from Boxalino (e.g.: current price might be not yet up-to-date in our index), implement a way to loop through the response blocks tree to detect all the instances of “bx-hit” parameter so you can load in one Database request all the prices needed for the display of the page, you can then simply add them to the JSON or provide them as an resource in the models of your templates

Step 2 : Prepare your Templates

Depending on which TPO WPO you will implement you will need to prepare different templates.

...

Info

Standard JSON queries are provided for each TPO WPO in the sections below, just copy them and adjust your parameters to test your queries on concrete cases.

...