Einstein Recommendations

La API de Einstein Recommendations tiene dos funciones principales: recibir actividades y producir recomendaciones. Nuestros clientes también pueden alcanzar flexibilidad para alternar recommenders sin cambios de código al usar nuestros componentes de zona.

Esta documentación de la API está pensada principalmente para los clientes de Salesforce Commerce Cloud.

Para habilitar el acceso a la API de Einstein Recommendations, vaya a Einstein Configurator e ingrese su identificación de cliente de Commerce Cloud Account Manager en la página de API. Con el acceso a Administrador del sitio, puede crear la identificación de cliente necesaria en la página de Account Manager. Para obtener más información, consulte Agregar una identificación de cliente de API.

Cuando está habilitada, y siempre que se pase la identificación de cliente correcta, la API funciona en todos los entornos, incluidas las instancias de Production, Staging, Development y sandbox.

Cada llamada de API debe pasar el encabezado x-cq-client-id para la autenticación de clave de API.

La implementación de nuestra API en el lado del cliente o del servidor tiene sus compensaciones. Para asegurarse de que mantiene en secreto la identificación de su cliente, le recomendamos implementar nuestra API en el lado del servidor para obtener una mayor seguridad. La implementación del lado del cliente corre el riesgo de exponer la identificación de su cliente a malos actores.

Las solicitudes para obtener recomendaciones, y determinadas actividades de los usuarios, como viewProduct, viewReco y clickReco, requieren consideraciones de almacenamiento en caché si se implementan del lado del servidor. Por ejemplo, en el caso de un usuario que ve una página de productos almacenada en caché, igualmente debería enviarse la actividad viewProduct. Es importante que Einstein reciba todos los eventos y que las recomendaciones no se almacenen en caché.

Esta API de Einstein Recommendations no está diseñada para el caso de uso de recomendaciones por correo electrónico. No admite la inserción de recomendaciones de Einstein en correos electrónicos.

Nuestro servicio se distribuye globalmente, es escalable horizontalmente y puede escalar automáticamente hacia arriba y hacia abajo en función del tráfico, por lo que es innecesario probar la carga. Le recomendamos evitar las pruebas de carga ya que afectan los resultados de recomendaciones.

Para ayudar a generar recomendaciones de productos relevantes para cada comprador, la API de Einstein Recommendations brinda parámetros para identificar a los compradores.

Para evitar actividad potencialmente maliciosa, los parámetros identificadores de usuarios no deber ser secuenciales. Los parámetros no deben incluir secuencias, patrones, direcciones IP, direcciones de correo electrónico, nombres ni nada vinculado a una persona específica. Todos los parámetros identificadores de usuarios deben cumplir con la Reglamento general de protección de datos (GDPR) a través de la función hash u otros métodos.
  • cookieId (obligatoria): identificador único de un comprador anónimo. Generalmente, cookieId es el valor de una cookie de primera persona.
    • Al hacer solicitudes de API desde un storefront tradicional de Commerce Cloud, pase el valor de la cookie cqcid para que coincida con el seguimiento de actividad automática en el storefront tradicional. Para obtener más información, consulte Almacenamiento de datos local basado en el navegador.
    • Cuando use las API de Salesforce Commerce, pase el valor USID disponible como parte del proceso de recuperación de token. Para obtener más información, consulte la documentación Inicio de sesión de comprador y API Access Service.
    • Al usar OCAPI, pase el valor visit_id de la respuesta de inicio de sesión de invitados para hacer coincidir las actividades automáticas. Para obtener más información, consulte el Documento de cliente de OCAPI.
  • userId (recomendado): identificador único de un comprador que inició sesión. Este parámetro le permite a Einstein vincular al mismo usuario que inició sesión en múltiples dispositivos.
    • Al hacer solicitudes de API desde un storefront tradicional de Commerce Cloud, pase el valor de la cookie cquid para que coincida con el seguimiento de actividad automática en el storefront tradicional. Para obtener más información, consulte Almacenamiento de datos local basado en el navegador.
    • Al usar las API de Salesforce Commerce, pase el valor hashed_login de la respuesta de inicio de sesión registrada para hacer coincidir las actividades automáticas. Para obtener más información, consulte la documentación Inicio de sesión de comprador y API Access Service.
    • Al usar OCAPI, pase el valor hashed_login de la respuesta de inicio de sesión registrada para hacer coincidir las actividades automáticas. Para obtener más información, consulte el Documento de cliente de OCAPI.

Los informes de rendimiento estándar para los recommenders usados a través de API de Einstein son iguales que para los demás recommenders usados en sus sitios digitales. Puede ver la presentación de informes en Informes y panel de Einstein (consulte este documento para obtener más información sobre Informes y panel de Einstein).

Para que sea más fácil generar informes y solucionar problemas por separado, le recomendamos crear recommenders separados para la API de Einstein. Por ejemplo, denominar a un recommender "pdp-mobile-API" indica que el recommender se usa en la página de detalles del producto de una aplicación móvil.

Las métricas de los informes se basan en las actividades. Si una aplicación que usa la API de Einstein Recommendations no envía actividades, todas las métricas para el recommender de API se muestran como cero (0).

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