1. Overview
This section provides information on how to prepare the script tags we'll add to your website to integrate the services from eyekandy.
How Integration Works
At eyekandy we syndicate our content to webpages using JavaScript script tags. When script tags are placed onto a page they should also include dataset
attributes that function as a mechanism to pass parameters.
To enable eyekandy services on your website you will need to place script tags on every page that you wish to load content for, due to this it's best to add the eyekandy script tags to a shared HTML template or via a Tag Manager software so that it can easily be added to many pages.
When adding the script tags, the following attributes must be present in the dataset
attributes of the script tags:
UUID
Identifies your websiteLanguage
Which language the content should load inSKU
Internal Stock Keeping Unit for the productMPN
The product's Manufacturer Part NumberEAN
The product's European Article NumberUPC
The product's Universal Product Code
When you pass all of the above attributes the eyekandy system will know which website to load the content for, the language to load it in, and which product we should load content for.
Library Files
At eyekandy we have 1x library file that is used to deliver all of our services, it is outlined in more detail below.
Main Library
- Contains logging, requires privacy policy/cookies acceptance
- Services: All interactive eyekandy Services
How Content Delivery works
At eyekandy we match our AR content to the products on your website using their "Product Identifiers", this is handled by our Matching Team.
When adding script tags to your page you will also pass your UUID, Language, and "Product Identifiers" (SKU, EAN, MPN), these will be sent to the eyekandy network backend for to check for a match. If there is a positive match for AR content for your match, it will be delivered via a service to your page.
From your side you will add the Main Library to all Product Pages so that there is no more set up or configuration steps after the integration is complete.
Services
At eyekandy we have a number of services that can be delivered to your page, eyekandy controls which services are enabled/disabled from our side.
AR Content
At eyekandy we create new AR content every day, we also routinely match your website(s) to our AR Model inventory. This can mean that after integration it's very likely eyekandy has more AR Models that can be served to the products in your inventory.
This process happens in the background and requires no action from you, it is made possible by adding the script tags to every Product Page so that eyekandy can serve AR content if it becomes available in future.
Look & Feel
There is some level of customisation available, primarily this is focused on the "trigger button" for the services.