When configuring Einstein Activities APIs, keep in mind these important call-related and identification-related API parameters.
- Parameters needed for all API calls:
siteId- Your Einstein site ID, which can be found in the top right of the page on Einstein Configurator. It has the format
xxxx-<Commerce Cloud Site ID>
clientId- The API key. To use Einstein API, you must authenticate by passing a query parameter with your Commerce Cloud Account Manager client ID. Customer admins can create the client IDs they need on Account Manager. For details, see this help topic.
- Identification-related parameters:
userId- Einstein does not handle cross-device management on our side. In order to link users across different devices, Commerce Cloud customers must collect and pass a shared ID through this
userId. Typically, only if the shopper is logged in and the login parameter is passed through this field, can shoppers be identified across device. To comply with GDPR, this field must be obscured through hashing or some other method.
cookieId- Pass a unique identifier in this parameter so that subsequent activities can be linked to the same user.
uuid- If you cannot generate a consistent
cookieIdfor a given user (don't have a way of distinguishing between people), you can use this parameter outputted by Einstein API instead. Each activity request returns a UUID representing the user, which can be stored and passed in subsequent calls.
Primarily intended for B2C Commerce, the Einstein Recommendations API uses activities that it receives to output recommendations. The
addToCart activities are required. The API calls send each activity to the Einstein engine when these events occur. The Einstein engine then uses the data gathered from these activities to generate recommendations that it returns to the site.
For more information about the Einstein Recommendations API and how to use it, see the B2C Commerce Einstein API.
The Progressive Web App (PWA) Kit is a framework for creating storefronts using the Retail React App. It is available as an open-source project on GitHub. The Retail React App is a customizable storefront that implements core ecommerce flows from home page to checkout.
To get started, see the PWA Kit and Managed Runtime documentation.