Última actualización:
Este documento es una guía para desarrollar integradores de sistemas entre los servicios de entrega y la plataforma Delivery App.
Los servicios de entrega son sistemas de control para las operaciones de entrega de productos físicos. Los productos se venden a través de la plataforma Delivery App y deben llegar a la dirección del consumidor, cuando la opción de compra es "entrega a domicilio".
La integración con Delivery App se lleva a cabo en tres fases, que se enumeran a continuación
FASE 1: Activación de la integración (asociación entre el servicio de entrega y la aplicación de entrega)
Esta fase se caracteriza por el inicio de la asociación entre Linx y la empresa de entrega, y está más allá del alcance de este documento.
FASE 2: Versión de integración (para cada nuevo cliente del servicio de entrega)
- El cliente expresa interés en contratar servicios de entrega y se pone en contacto con la empresa proveedora; no hay costos para el cliente debido a la aplicación de entrega;
- Después de firmar el contrato, el servicio de entrega o el cliente informa a Linx de la clave de identificación (token de servicio);
- Linx registra el token de servicio en la plataforma de la aplicación Delivery. A partir de ese momento, el icono de llamada del servicio de entrega se presenta al cliente en el tablero de la tienda y en Neemo Connect;
FASE 3: Operación (en cada cliente que tiene el servicio liberado)
- El consumidor realiza un pedido en la plataforma Delivery App;
- El pedido debe confirmarse. Esta confirmación puede ser manual (cuando el cliente no tiene integración de pedidos) o automática (cuando el cliente tiene integración de pedidos con su sistema POS);
- Con el pedido confirmado, el cajero del cliente debe interactuar y hacer clic en el icono que representa el servicio de entrega deseado;
- Al hacer clic en el icono de llamada, la plataforma Delivery App enviará una solicitud HTTP POST a una dirección (webhook) disponible en la plataforma tecnológica de la empresa de servicios de entrega;
- Al recibir la solicitud de entrega, la plataforma tecnológica del servicio de entrega debe consultar los detalles del pedido en la plataforma Delivery App para que sea posible calcular, en base a la dirección de entrega, tarifas, disponibilidad, poner en espera, confirmar o rechazar la solicitud;
- Según el estado de la solicitud (en espera, confirmada, rechazada), el cajero del cliente decide confirmar la solicitud, o cancelarla, directamente en la plataforma del servicio de entrega.
Información de desarrollo
Componentes involucrados
Artículo | Descripción | Responsable |
---|---|---|
URL "webhook" | Dirección web accesible por protocolo HTTP | servicio de entrega |
API de pedido | API REST para devolver los detalles de un pedido | Neemo Delivery App |
token de servicio | Identificador de cliente con el servicio de entrega. | servicio de entrega |
account_access_token | Identificador de una tienda cliente específica. Le permite consultar pedidos de un determinado Tienda. | Neemo Delivery App |
master_access_token | Identificador de una cadena de tiendas. Le permite consultar pedidos de todas las tiendas. | Neemo Delivery App |
Formato de solicitud de entrega
La solicitud enviada por la plataforma Delivery App tiene el formato de una solicitud HTTP con los siguientes parámetros:
Item | Valor |
---|---|
METHOD | POST |
HEADER Content-Type | application/json |
HEADER Authorization | Token de autorización informado por el servicio de entrega. |
BODY | { |
Después de recibir la solicitud enviada por la plataforma de la aplicación de entrega, el servicio de entrega debe proceder con una consulta a la API de pedidos de la aplicación de entrega para determinar los detalles necesarios para la entrega, como la dirección, el nombre del consumidor y la necesidad de devolver a la persona que realiza la entrega.
Consulte la documentación específica de la API en https://deliveryapp.neemo.com.br/api/docs/?integration=true#!/order/POST_version_order_order_id