Einstein Recommendations

L’API Einstein Recommendations a deux fonctions principales : recevoir des activités et émettre des recommandations. Nos clients peuvent également bénéficier d’une certaine souplesse pour changer de recommender sans modifier le code, grâce à nos composants Zone.

Cette documentation sur les API est principalement destinée aux clients de Salesforce Commerce Cloud.

Pour activer l’accès à l’API Einstein Recommendations, rendez-vous sur Einstein Configurator, et saisissez votre identifiant client Commerce Cloud Account Manager dans la page API. En utilisant l’accès de l’administrateur du site, vous pouvez créer l’identifiant client nécessaire sur la page Account Manager. Pour plus d’informations, voir Ajouter un identifiant de client API.

Lorsqu’elle est activée, et à condition que le bon identifiant client soit transmis, l’API fonctionne dans tous les environnements, y compris les instances production, staging, development et sandbox.

Chaque appel d’API doit passer l’en-tête x-cq-client-id pour l’authentification de la clé d’API.

L’implémentation de notre API côté client ou côté serveur s’accompagne de certains compromis. Pour préserver le secret de votre identifiant client, nous vous recommandons d’implémenter notre API côté serveur afin d’améliorer la sécurité. L’implémentation côté client présente le risque d’exposer votre identifiant client à des acteurs malveillants.

Les requests pour obtenir des recommandations, et certaines activités de l’utilisateur comme viewProduct, viewReco, et clickReco, requièrent des considérations de mise en cache si elles sont implémentées côté serveur. Par exemple, dans le cas d’un utilisateur qui consulte une page de produit mise en cache, l’activité viewProduct doit quand même être envoyée. Il est important qu’Einstein reçoive tous les événements, et que les recommandations ne soient pas mises en cache.

L’API Einstein Recommendations n’est pas conçue pour le cas d’utilisation des recommandations par e-mail. Elle ne prend pas en charge l’intégration des recommandations Einstein dans les courriers électroniques.

Notre service est distribué à l’échelle mondiale ; il est évolutif à l’horizontale et peut automatiquement monter et descendre en charge en fonction du trafic, de sorte que les tests de charge sont inutiles. Nous vous recommandons d’éviter tout test de charge car cela affecte les résultats des recommandations.

Pour aider à générer des recommandations de produits pertinentes pour chaque acheteur, l’API Einstein Recommendations fournit des paramètres pour l’identification de l’acheteur.

Pour éviter toute activité malveillante potentielle, les paramètres d’identification de l’utilisateur doivent être non séquentiels. Les paramètres ne doivent pas inclure de séquences, de schémas, d’adresses IP, d’adresses électroniques, de noms ou tout autre élément lié à une personne spécifique. Tous les paramètres d’identification des utilisateurs doivent se conformer au règlement général sur la protection des données (RGPD) par le biais d’un hachage ou d’autres méthodes.
  • cookieId (obligatoire) : identifiant unique d’un acheteur anonyme. En général, cookieId est la valeur d’un cookie de première partie.
    • Lorsque vous lancez des requests API à partir d’une boutique Commerce Cloud classique, passez la valeur du cookie cqcid pour correspondre au suivi automatique des activités sur la boutique classique. Pour plus d’informations, reportez-vous à la section Stockage de données local basé sur navigateur.
    • Lors de l’utilisation des API Salesforce Commerce, transmettez la valeur USID disponible dans le cadre du processus de récupération de jeton. Pour en savoir plus, voir la documentation du Shopper Login and API Access Service (SLAS).
    • Si vous utilisez OCAPI, transmettez la valeur visit_id de la réponse de connexion de l’utilisateur invité pour la correspondance des activités automatiques. Pour plus d’informations, consultez le Document client OCAPI.
  • userId (recommandé) : identifiant unique d’un acheteur connecté. Ce paramètre permet à Einstein de relier le même utilisateur connecté entre plusieurs appareils.
    • Lorsque vous lancez des requests API à partir d’une boutique Commerce Cloud classique, passez la valeur du cookie cquid pour la correspondance lors du suivi automatique des activités sur la boutique classique. Pour plus d’informations, reportez-vous à la section Stockage de données local basé sur navigateur.
    • Si vous utilisez les API Salesforce Commerce, transmettez la valeur hashed_login de la réponse de connexion de l’utilisateur enregistré pour la correspondance des activités automatiques. Pour en savoir plus, voir la documentation du Shopper Login and API Access Service (SLAS).
    • Si vous utilisez OCAPI, transmettez la valeur hashed_login de la réponse de connexion de l’utilisateur enregistré pour la correspondance des activités automatiques. Pour plus d’informations, consultez le Document client OCAPI.

Les rapports de performance standard pour les recommenders utilisés via l’API Einstein sont les mêmes que pour les autres recommenders utilisés sur vos sites numériques. Vous pouvez consulter ces rapports dans Einstein Reports & Dashboard (reportez-vous à ce document pour en savoir plus sur Einstein Reports & Dashboard).

Pour faciliter la séparation de la création de rapports et du dépannage, nous vous recommandons de créer des recommenders différents pour l’API Einstein. Par exemple, nommer un recommender « pdp-mobile-API » indique qu’il est utilisé sur la page des détails du produit dans une application mobile.

Les statistiques des rapports sont basées sur les activités. Si une application utilisant l’API Einstein Recommendations ne parvient pas à envoyer des activités, toutes les statistiques pour le recommender de l’API s’affichent à zéro (0).

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.