General setup — unsupported platforms
This guide is meant as a guideline for external developers, either setting up unsupported platforms or creating extensions that integrate shop platforms with Hello Retail. The process for a single setup or creating an extension is almost identical, so we have combined it in a single guide.
"Unsupported platforms" does not mean that Hello Retail can't be implemented, but just that an extension for quick installation hasn't been developed yet. Therefore the implementation process will require some manual steps, that we will go through in this guide.
The guide is divided into sub-guides, that covers all you need to do. Please go through all linked guides and return to this page until you have been through all of them.
If you run into issues following the guidelines set in this guide, then please contact our support team so we can discuss possible solutions.
You can find our API-documentation here: https://apidocs.helloretail.com.
Extension UI requirement:
If you are creating an extension, the extension requires some interaction with the user, so that user-specific information can be entered. If you are not creating an extension, you can skip this part.
The extension needs to provide a simple UI where the following two things can be accomplished:
- Insert and save the unique Hello Retail partner ID.
- Generate and save a random key for the data feed access authentication.
- Insert container Divs with specifically provided ID's at targeted locations throughout the site (This one is not strictly required).
1: Tracking requirements
The basis of all Hello Retail products is a thorough analysis of customer data and habits. This analysis, of course, is based on data obtained through customer interaction with the shop. Therefore it is crucial that customer tracking is set up correctly, for the shop to fully benefit from Hello Retail.
2: Markup insertion requirements
For Hello Retail to be able to correctly display and place either Product Recommendations or Search, you need to prepare the webshop with a few snippets of additional code.
3: Data synchronization requirements
A complete overview of the webshops products and orders is crucial — follow this guide to set up automatic synchronization.