Configurations
The base rtux-shopware repository will allow the integration layer to access Boxalino-specific configurations via the required BoxalinoRealTimeUserExperienceApi ConfigurationInterface.
In the Shopware6 admin, the configurations are in the Settings >> System >> Plugins >> Boxalino RTUX Framework for Shopware v6 path (or admin#/sw/plugin/settings/BoxalinoRealTimeUserExperience)
- Boxalino Account is provided by Boxalino on your account kick-off.
- API Key and the API Secret are available in the IA API credentials view. Use the ones with CORE role
- When "Use Development Data Index" is enabled, the JSON request will have the parameters
"dev":true
; this will link your API request to the development data index available for your account.
Keep in mind: The development data index access uses different ApiKey/ApiSecret/JS API Key credentials. Please use the credentials (dev=true or dev=false) as they have been provided.
Read more about the available Data Indexes.
- The REST API URL must be https://domain.bx-cloud.com/narrative/account/api/1 where domain is main/r-st/ch depending on your instance context (production or staging); account is the account name for the channel.
- When Test mode is enabled, the JSON request will have the parameters
"test":true
set; in this mode - the JSON request is logged and the tracker debug mode is activated.
When the tracker debug mode is activated, the tracked elements can be viewed in real-time. On the project, all tracked elements will have a stripped border as the tracking events are being sent. Use this to validate that your tracking is properly integrated.
- The JS API Server Key is available in IA API credentials view; Use the API key for the PUBLIC_NARRATIVE role. This is the API key that will allow your setup to make the Autocomplete JS requests
Enabling the tracker will send JS tracking requests for the configured events with the use of the RtuxApiTrackerPlugin
The tracker must be enabled. Within the Boxalino services, the tracked events are a main source for reports, a/b testing, real-time personalizations.
Please make sure the required setup initilization steps have been done.