Home - boxalino/rtux-integration-magento2 GitHub Wiki

Boxalino Winning Interactions platform is provided through Boxalino Narrative API: a REST API supporting a configurable JSON data structure as input and output.

This repository provides you samples of how to access to this API through the framework layer. You will therefore not need to access the API directly.

The API can be directly called by following the official Narrative API Technical References

The Boxalino Real Time User Experience (RTUX) Integration repository consists of integration guidelines aiming to assist the integration teams assigned with the Boxalino project. It will provide code samples to the most commonly used default requests which covers the vast majority of cases for the typical Boxalino integration.

If you are new to using Boxalino in a Magento 2 environment, please have first a look at our introduction documentation here

Before continuing, make sure that:

  1. a narrative API endpoint has been provided for the Boxalino account
  2. the Boxalino account has an active data index (be it development or production)
  3. the working setup is using the appropriate configurations (dev/test flags, API key, account name, etc)

For your information, here is the official Narrative API Technical References.

Before you start

Before trying to make any API call, make sure you have followed these steps:

  1. Make sure you have received your access credentials (Account, API key (dev/prod), API secret (dev/prod), JS API Server Key, REST API Url, Password (exporter/admin))
  2. Install the data exporter
  3. Execute a full product data export successfully (either in the development or the production data index) as explained here: Configure the data exporter
  4. Complete the general configurations of the framework layer: Configurations
  5. Enable the JavaScript tracker in the framework layer: Tracker
  6. Declare the Response Registry (used to store the API response and access it for further blocks & layout regions)
  7. Declare the Sorting interface
  8. Get acquainted with our back-end: Boxalino Intelligence Admin

We recommend that you do a go-live already when you have completed these 8 points without any API calls integrated, so that Boxalino can prepare your Data Science Ecosystem environment and start to collect statistics (particularly important if your first project includes search).

Optionally, you can use the tag version 1.0.0.1 as an idea on what is the base of the integration layer.

Integration order

For an organic migration to the Boxalino eco-system, we recommend the integration order as described on the Features Integration wiki

Keep in mind that before any API request can be done:

  1. the data index must exist
  2. if you exported data in dev, you must set the request parameter dev = true, if you have exported the data in prod, you must set it to false
  3. the narratives must exist in Intelligence Admin
  4. if you have published your narratives in the admin, you can set the request parameter test = false, but if you only click on test, you must set it to true (5 minutes cache apply).

Initial Setup

If you want to install the entire repository as available (for local/testing/demo environments), please check the Initial Setup guidelines