API Delivery Much

VERSÃO 2.0 - ORIENTAÇÕES GERAIS - ATUALIZADO EM: 06/2020

PROCESSO DE INTEGRAÇÃO
Interesse
1. Leitura da
documentação da
Delivery Much:
https://developer.deliverymu
ch.com.br/
2. Formalização de
interesse na integração
com a API:
https://lojistas.zendesk.com
/hc/pt-br/requests/new?tick
et_form_id=360001946992
Desenvolvimento Homologação
5. Retorno solicitando
agendamento da
homologação junto ao
3. Parceiro recebe as
time de Engenharia de
credenciais de
Software da Delivery
desenvolvimento pelo
Much.
email de cadastro.
6. Assinatura do
4. Prossegue na
contrato digital entre
priorização da
ambas as partes.
integração com seu
time de time de
7. Após homologação,
desenvolvimento.
recebimento das
credenciais de
produção.
Primeiros passos
Eventos
A API está especificada em: https://developer.deliverymuch.com.br/
A documentação é interativa, podendo ser utilizada diretamente pelo browser. Cada rota descreve detalhes
sobre os requisitos e regras de negócio da operação a ser realizada.

A nossa API contempla os seguintes eventos:

● Tornar online/offline
● Alterar tempos médios de entrega/busca,
● Marcar pedido como recebido/aberto/lido/impresso,
● Aceitar pedido, marcar pedido como pronto para entregar e cancelar pedido.

Todos os eventos acima são obrigatórios para a homologação junto a Delivery Much Brasil.
Operações como sincronização com cardápios e cadastro/edição/exclusão de produtos são avanços
previstos para uma futura versão da API.
Rotas da API
As rotas estão documentados na coleção do Postman anexa ao e-mail. Você pode obter o Postman como um add-on do
Chrome ou como cliente standalone.
As rotas estão agrupadas em pastas, por tipo de domínio/recurso. Cada pasta e rota possui uma documentação, visualizada
diretamente pelo Postman.

Configuração do Postman
O arquivo de ambiente, com suas credenciais e variáveis declaradas, se encontra nos anexos. Você apenas precisará criar um
novo ambiente no Postman e inserir o conteúdo do arquivo.

Endereços
Ambientes de testes (utilizados nas rotas da coleção do Postman):
https://devmuch-api.auth0.com: Serviço de autenticação e autorização, para desenvolvimento e testes.
https://api.devmuch.io/: API em ambiente de testes e homologação.

Ambiente de produção:
https://auth.deliverymuch.com.br Serviço de autenticação
https://api.deliverymuch.com.br: API

Quando estiver tudo encaminhado para que a integração do seu PDV vá para o ar, iremos gerar as credenciais
de produção. As credenciais do ambiente de testes, bem como os tokens de acesso gerados através delas,
não funcionarão no ambiente de produção.
Autenticação
Utilizamos o fluxo Resource Owner Password Grant, do protocolo OAuth2.
O arquivo com as credenciais contém client_id e o client_secret, que serão a identificação da sua aplicação PDV para
os nossos sistemas e que permitirão que restaurantes autentiquem conosco através da sua aplicação. O par de
credenciais são exclusivos para o ambiente de testes.

Já as credenciais username e password são da loja, para autenticar através do ERP integrado. O arquivo de
ambiente encaminhado possui credenciais de um restaurante fictício disponível para testes.

Para a autenticação funcionar corretamente, é necessário que a loja tenha um email cadastrado em nosso sistema.
No ambiente de desenvolvimento esse requisito é garantido, no entanto, em produção a loja deve confirmar seu
cadastro com o representante local da Delivery Much caso a autenticação falhe.

O UUID do restaurante, utilizado nas rotas ou filtros de algumas operações, está contido nas user claims do token de
acesso e é necessário extraí-lo. Vocês podem inspecionar os tokens em https://jwt.io/ e verificar quais bibliotecas
podem usar para pegar lidar com os JWTs.

Na coleção do Postman que enviamos, utilize a rota Access Token para se autenticar. A rota se encontra na pasta
Autenticação.
As rotas das demais pastas exigem um token de acesso e permissões específicas.
Fluxo de pedidos
Criação de pedidos
Para facilitar os testes e o fluxo, criamos uma rota para criar pedidos facilmente no ambiente de testes. A rota se chama
"Criar pedido fictício" e se encontra na pasta Pedidos. Com um token de acesso, basta enviar a solicitação. A resposta é o UID
do pedido criado.

Caso um pedido seja feito e a loja não o aceite dentro de 15 minutos, o pedido é cancelado e a loja é colocada como offline.

É possível customizar algumas coisas no pedido fictício, como forma de recebimento do pedido (em domicílio ou retirada no
restaurante) e inclusão de um cupom de desconto, através de alguns parâmetros do corpo da requisição.

Esses parâmetros são explanados na documentação da rota no Postman. Infelizmente não conseguimos oferecer total poder
de customização nos pedidos fictícios pois sua criação e validação ocorrem em fluxos alternativos ao nosso processo de
checkout.
Fluxo de pedidos
Uma explicação sobre fluxo de pedidos
(estados e etapas) foi adicionada à pasta de
Pedidos, na coleção no Postman.
Meios de pagamento
A Delivery Much oferece três meios de pagamento aos usuários: dinheiro, máquina móvel ou pagamento online.

Pagamentos por máquina móvel dependem dos cartões aceitos pelo estabelecimento. Esses cartões deverão ser
previamente cadastrados pelos restaurantes em conjunto com a franquia/franqueadora da Delivery Much. Quanto
aos pagamentos online, hoje trabalhamos apenas com Visa e MasterCard.

Estou te enviando um arquivo com a relação dos cartões (ID e nome) para que vocês consigam mapear com as
definições do ERP.
FAQ
Após a homologação, como prosseguimos com o cadastro de produtos?
O cadastro de produtos é prosseguido diretamente pelo nosso franqueado local da cidade do PDV.
Para fins de acompanhamento, uma vez que o cadastro já tenha sido feito e a integração esteja homologada, o
nosso franqueado poderá cadastrar o ID_ERP de cada produto presente em seu sistema, diretamente no Painel
administrativo onde é feita toda gestão de produtos.

Quais as credenciais de acesso do PDV?

Para facilitar todo o processo de integração, o PDV deverá utilizar as mesmas credenciais de acesso do nosso
gestor de pedidos (Eugênio), uma vez que tenha um email previamente cadastrado conosco.

O que pode bloquear o acesso de um PDV?

Por questões de segurança, caso seja identificado uma alta quantidade de tentativas de login o PDV poderá ser
bloqueado, necessitando que entrem em contato conosco para o desbloqueio, através dos canais de suporte.

O PDV pode utilizar o nosso ERP e o Gerenciador de pedidos da Delivery

Much ao mesmo tempo?
Sim, ambos podem ser utilizado em conjunto, de modo que melhor atenda a sua operação.
Canais de Suporte
Ainda possui dúvidas? Entre em contato conosco!
ERPs e Software Houses

Dúvidas técnicas e cadastro inicial

https://lojistas.zendesk.com/hc/pt-br/requests/new?ticket_form_id=36
0001946992

Produto e Parcerias
Flávio Oliveira - Product Operations Manager
suporte.tech@@deliverymuch.com.br

Pós Venda para Lojas parceiras (PDVs em geral)

O atendimento as lojas parceiras é centralizado com os nossos

franqueados/área de relacionamento de acordo com a
cidade do PDV em questão.
EUGÊNIO APP