Última atualização: 2705
...
Este documento é um guia para o desenvolvimento de sistemas integradores entre serviços de entrega e a plataforma Delivery App.
...
A integração com o Delivery App ocorre em três fases, relacionadas a seguir.
FASE 1: Ativação de Integração (parceria entre serviço de entregas e Delivery App)
- A empresa operadora de entregas aborda a Linx e solicita instruções sobre o desenvolvimento e funcionamento da integração com o Delivery App;
- A Linx envia em um email à empresa operadora, solicitando informações de contato, entre outras;
- Com os dados, a equipe Linx faz o registro da empresa operadora na plataforma Delivery App, e envia um email contendo as informações para o desenvolvimento;
- Ao término do desenvolvimento, a empresa operadora deve avisar à Linx para que a relação de empresas compatíveis com o Delivery App;
FASE 2: Liberação de Integração (a cada novo cliente do serviço de entregas)
- Cliente manifesta interesse em contratar os serviços de entrega e faz contato com a empresa prestadora - não há custos para o cliente, por parte do Delivery App;
- Após firmado o contrato, o serviço de entregas OU o cliente, informam à Linx a chave de identificação (token do serviço);
- A Linx registra o token do serviço na plataforma Delivery App - a partir desse momento, o ícone de chamada do serviço de entregas passa a ser apresentado ao cliente no painel da loja e no Neemo Connect;
FASE 3: Operação (em cada cliente que tenha o serviço liberado)
- Consumidor faz um pedido na plataforma Delivery App;
- O pedido precisa ser confirmado. Essa confirmação poderá ser manual (quando o cliente não possuir integração de pedidos) ou automática (quando o cliente possui integração de pedidos com seu sistema PDV);
- Com o pedido confirmado, o operador de caixa do cliente deve interagir e clicar no ícone que representa o serviço de entregas desejado;
- Ao clicar no ícone de chamada a plataforma Delivery App enviará uma requisição HTTP POST para um endereço (webhook) disponibilizado na plataforma tecnológica da empresa de serviço de entregas;
- Ao receber a solicitação de entrega, a plataforma tecnológica do serviço de entrega deverá consultar os detalhes do pedido na plataforma Delivery App para que seja possível calcular, com base no endereço para entrega, tarifas, disponibilidade, colocar em espera, confirmar, ou rejeitar a solicitação;
- De acordo com o status da solicitação (em espera, confirmada, rejeitada), o operador de caixa do cliente decide por confirmar a solicitação, ou cancelá-la, diretamente na plataforma do serviço de entrega.
...
Informações para o Desenvolvimento
Componentes envolvidos
| Item | Responsável | |
|---|---|---|
| URL "webhook" | Endereço web alcançável pelo protocolo HTTP para receber a solicitação de entrega enviada pela plataforma Delivery App. | Serviço de entregas |
| API de pedido | API REST para devolver detalhes de um pedido para que o serviço de entregas possa avaliar disponibilidade, formar preço, e confirmar ou rejeitar a solicitação de entrega. | Neemo Delivery App |
| Token do serviço | Identificador do cliente junto ao serviço de entregas. | Serviço de entregas |
| account_access_token | Identificador de uma loja específica do cliente. Permite consultar pedidos de uma determinada | Neemo Delivery App |
| master_access_token | Identificador de uma rede de lojas. Permite consultar pedidos de todas as lojas. | Neemo Delivery App |
Formato da Solicitação de Entrega
A solicitação enviada pela plataforma Delivery App é formatada como uma requisição HTTP com os seguintes parâmetros:
| Item | Valor |
|---|---|
| METHOD | POST |
| HEADER Content-Type | application/json |
| HEADER Authorization | token de autorização informado pelo serviço de entregas. |
| BODY | { |
Após receber a solicitação enviada pela plataforma Delivery App, o serviço de entrega deverá proceder com uma consulta à API de pedido Delivery App para determinar os detalhes necessários para a entrega, como endereço, nome do consumidor, e necessidade de retorno do entregador.
...