Error #1239
Desarrollo de App de Reseñas Automáticas en VTEX
0%
Descripción
- 1. Definición Funcional
Objetivo: Automatizar la solicitud de reseñas mediante correo electrónico tras la compra de productos específicos (filtros por ID o Marca) y centralizar el feedback en el módulo nativo de "Reviews and Ratings" de VTEX.
Flujo de Usuario:
1. El cliente realiza una compra.
2. El sistema detecta si el pedido contiene productos o marcas "objetivo".
3. Tras un tiempo de espera (delay para entrega y uso del producto), se envía un mail con una encuesta.
4. El cliente responde la encuesta.
5. La respuesta se inserta automáticamente como una reseña en la tienda.
- 2. Arquitectura Técnica y Pasos para el Desarrollador
Para lograr esto de forma escalable dentro del ecosistema VTEX, se recomienda usar VTEX IO y el motor de Master Data V2 Triggers.
- Paso 1: Configuración del Trigger (Disparador)
En lugar de monitorear la API de pedidos constantemente, utilizaremos los Triggers de Master Data sobre la entidad O (Orders).
- Configuración: * Entidad: Order (O). * Evento: Cuando un pedido cambia al status invoiced (facturado). * Filtro: Aquí es donde aplicas la lógica de negocio. Puedes filtrar por brandId o productId. * Acción: Enviar un HTTP POST a un Middleware (una App de VTEX IO o un servicio externo).
- Paso 2: Desarrollo del Middleware (App en VTEX IO)
Necesitas un servicio que procese el evento del trigger.
1. Recepción: El trigger envía los datos del pedido (ID de pedido, email del cliente, lista de productos).
2. Delay de cortesía: No puedes enviar el mail inmediatamente. El middleware debe programar una tarea (usando un Scheduler o una cola tipo SQS) para esperar N días (ej. 7 días tras la entrega).
3. Integración con Email Service: Al cumplirse el tiempo, el servicio envía la encuesta (vía SendGrid, AWS SES o el propio Message Center de VTEX).
* Tip: El link de la encuesta debe llevar parámetros en la URL (Token, ProductID, UserEmail) para que el cliente no tenga que loguearse de nuevo.
- Paso 3: Captura de Datos y Carga de Review (API de Reviews)
Una vez que el usuario completa tu encuesta, tu app debe capturar esos datos y enviarlos a VTEX.
- Endpoint: `POST https://{accountName}.{environment}.com.br/reviews-and-ratings/api/review`
- Payload requerido:
```json {
"productId": "123",
"rating": 5,
"title": "Excelente producto",
"text": "Me encantó la calidad, llegó a tiempo.",
"reviewerName": "Juan Pérez",
"shopperId": "juan@email.com",
"verifiedPurchaser": true
}
```
- Seguridad: Debes usar un `VtexIdclientAuthenToken` o un `AppKey/AppToken` con permisos de escritura en el módulo de Reviews.
- 3. Checklist de Implementación (Hoja de ruta)
1. Instalar App de Reviews: Asegúrate de que la app `vtex.reviews-and-ratings` esté instalada y configurada en la cuenta.
2. Definir Criterios de Selección: Crear una tabla de configuración (pueden ser archivos `.json` en la app o una tabla en Master Data) con los IDs de marcas o productos que disparan la encuesta.
3. Configurar Trigger en Master Data:
* Ir a `https://{account}.myvtex.com/admin/master-data`
* Configurar el trigger para que apunte al endpoint de tu aplicación.
4. Desarrollar el Formulario de Encuesta: Una landing page simple (puede ser una página en VTEX Store Framework) que reciba los parámetros de la URL y haga el POST a la API de Reviews.
5. Manejo de Moderación: Por defecto, las reviews entran en estado "pendiente". Deberás decidir si las apruebas automáticamente vía API (usando el campo `approved: true` si el permiso lo permite) o si un administrador las modera manualmente.
- Ventajas de este enfoque:
- Filtro Eficiente: No molestas a todos los clientes, solo a los que compran las marcas que te interesan.
- Prueba Social: Al usar la API oficial, las estrellas se mostrarán automáticamente en los componentes nativos de la tienda (Shelf, Product Page).
- Automatización: Una vez configurado el Trigger, el proceso no requiere intervención humana.