Introducción
Esta guía proporciona los detalles necesarios para integrar datos con Midway utilizando la integración API. Este método permite una transferencia diaria y eficiente de información clave, particularmente útil para integrar datos de tiendas físicas y/o e-commerces sin integración directa.
Conexión típica
A continuación, se presenta un diagrama que ilustra una conexión típica entre los datos de la compañía y la plataforma Midway:
Entidades en color verde son requeridas.
Entidades en color celeste son opcionales.
Consideraciones para la conexión
Autenticación: Se realiza mediante un token de acceso a traves de Authorization: Bearer <Token>.
Proyecto (espacio de trabajo): X-Tenant del proyecto.
Recomendamos leer
Preparación de los datos
Midway maneja los datos divididos en las siguientes entidades: Audience; Orders; Products; Categories; Carts. Es necesario enviar a cada endpoint de la API los datos para cada entidad. Los nombres de las columnas deben coincidir exactamente con los solicitados en esta documentación.
Ejemplos de datos y campos disponibles
Cada entidad debe incluir campos obligatorios y opcionales, con la posibilidad de agregar campos adicionales específicos de la marca, conocidos como "campos dinámicos". A continuación se presentan ejemplos y campos necesarios:
Audience (Clientes)
Integración de datos completos de su audiencia que serían sus clientes, incluyendo el identificador de email y datos adicionales como geográficos, de género y de cumpleaños.
👉 Información adicional: Esta entidad permite agregar campos dinamicos. ¿Qué son? Son campos que no son nativos en Midway, como tipo de membresía, tienda de registro o deporte favorito. Para parametrizarlos en Midway, puedes seguir las Instrucciones.
Sales (ventas)
Integración de datos de ventas, incluyendo identificador del comprador, datos de la venta y productos comprados.
Referencias importantes:
Enviar el email para identificar al cliente.
Si esta subiendo información de tiendas físicas:
Los SKUs deben coincidir con los del E-commerce.
No enviar ventas del E-commerce.
Content (productos)
Integración de datos de productos.
Categorías (categories)
Integración de datos de categorías.
Carritos abandonados (carts)
Integración de datos de carritos abandonados.
Referencias importantes:
Enviar el email para identificar al cliente.
Buenas prácticas
Para garantizar una integración eficiente y precisa, se recomienda seguir estas buenas prácticas:
Entidad audience
Evitar enviar clientes sin identificar. Cada cliente debe incluir información clave que permita su correcta asociación y gestión.
Entidad sales
No enviar ventas sin datos del cliente. Toda venta debe incluir información completa del cliente asociado para asegurar un procesamiento adecuado.
Si estás subiendo información de tiendas físicas:
Asegúrate de que los SKUs coincidan con los del E-commerce.
No incluyas ventas provenientes del E-commerce para evitar duplicados.
Entidad content
La URL debe coincidir exactamente con la página del producto en el E-commerce. Esto asegura que los usuarios puedan acceder al producto correcto al interactuar con las campañas o la personalización web.
Proceso de sincronización de datos
Midway sincroniza y procesa los datos en tiempo real que se envíen a través de la API.
Este enfoque garantiza que las empresas siempre cuenten con información actualizada y precisa, optimizando sus estrategias de marketing y mejorando la segmentación de audiencias.
Proceso histórico de datos
Para integrar datos históricos de hasta dos años, recomendamos que realice varias llamadas a nuestra API con bloques de datos, puede enviarnos de a 1000 bloques de datos como clientes, ventas, productos y el sistema lo irá procesando.
El procesamiento se realizará durante el sprint pactado en la “Reunión Técnica”. Una vez finalizada, será necesaria una validación de los datos por parte del cliente. En caso de una demora en la entrega de los datos, se modificará el deadline del proyecto.
Validación de datos
Audience
En Midway, ir a Audiencia > Perfiles. Puede haber más clientes que en su base de datos debido a la creación de clientes a partir de ventas.
Sales
En Midway, ir a Audiencia > Perfiles > Seleccionar un contacto y visualizar la información histórica de ventas para ese perfil.
Content
En Midway, ir a Contenido > Productos.
Carts
En Midway, ir a Audiencia > Perfiles > Seleccionar un contacto y visualizar la información de carrito abandonado.
Contingencias
Contacto con soporte
Si la falla persiste, contactar a [email protected].
Recomendaciones para el Inicio del Proyecto
Preparación de los datos
Es crucial comenzar preparando los datos y verificando que tenemos todos los datos que son requeridos. Para resolver cualquier duda, consulta la información de ejemplo de la documentación de cada entidad.
Desarrollo inicial
Se recomienda iniciar el desarrollo con la entidad más sencilla: Audience. Esto permitirá establecer una base sólida antes de avanzar con entidades más complejas.
Documentación de procesos
Es fundamental documentar cada paso del proceso de integración. Esto garantizará una comprensión clara del flujo de datos y servirá como referencia para futuras necesidades.
Monitoreo y optimización
Implementa un sistema de monitoreo desde el inicio para verificar que la integración se realice correctamente. Además, optimiza el proceso según los resultados obtenidos, asegurando una integración más eficiente a lo largo del tiempo.
Timeline del proyecto de integración
Para asegurar una integración exitosa de los datos con la plataforma Midway, se ha definido un timeline detallado con fechas aproximadas que guiará el proceso desde el inicio hasta la finalización.
Kickoff
Esta es la fase inicial del proyecto donde se establece el alcance y los objetivos de la integración.
Día 0.
Reunión técnica
Reunión entre los equipos técnicos de Midway y el cliente para revisar los requisitos y resolver cualquier duda técnica.
+3 días desde el kickoff.
Chequeo de procesamiento en tiempo real
Midway procesa y valida los enviados diariamente entregados por el cliente, asegurándose de que todos los datos se han integrado correctamente.
+7 días desde la Reunión técnica.Chequeo de procesamiento de datos históricos
Midway procesa y valida los datos históricos entregados por el cliente, asegurándose de que todos los datos se han integrado correctamente.
+10 días desde la Reunión técnica.Finalización del Setup
Validación final y ajustes necesarios. Esta fase incluye la revisión de la integración completa y la confirmación de que todos los datos se procesaron correctamente en Midway.