Integração Goomer
Last updated
Was this helpful?
Last updated
Was this helpful?
Este documento descreve a API de integração para as soluções em delivery, QR code, autoatendimento e tablet.
Disponibilizamos endpoints online para consulta e alterações de status dos pedidos recebidos. Também enviamos webhooks à cada novo evento para que sua aplicação possa recebê-los em um endpoint próprio. Caso o uso de webhooks não seja possível, pode-se utilizar polling para consulta dos eventos.
A figura abaixo exibe o diagrama simplificado da integração, onde a automação é notificada via webhook que um novo pedido está disponível. Em seguida, com o id do pedido recebido, a automação busca os detalhes do pedido e tenta integrá-lo ao sistema. Em caso de sucesso, a automação chama a rota de aceite de pedido, indicando que o pedido foi integrado com sucesso.
Veja nas próximas seções os detalhes de autenticação, endpoints para controle dos pedidos e formato dos webhooks.
Todos os pedidos são exibidos no painel da Goomer para que o restaurante tenha controle dos pedidos e seja capaz de tratar eventuais erros de integração sem que isso seja exibido para o cliente final. Os estados de integração dos pedidos e como eles são exibidos para o restaurante em nosso painel são descritos abaixo.
Quando um pedido inicia a tentativa de integração, é exibido um loader indicando que a automação está processando o pedido. Esse loader é mantido até a automação aceite ou recuse o pedido, ou até que o tempo-limite de 90 segundos seja excedido.
Um pedido é aceito quando a automação consegue integrá-lo com sucesso e notifica a Goomer através da rota de aceite de pedido.
No painel de pedidos da Goomer o pedido aceito será exibido da seguinte forma:
Um pedido é recusado quando a automação encontra problemas para integrar o pedido, e notifica a Goomer pela rota de recusa de pedido.
No painel de pedidos da Goomer o pedido aceito será exibido da seguinte forma:
Um pedido pode ser cancelado de duas formas:
Quando o restaurante cancelar o pedido pela automação e esta chamar a rota de cancelamento de pedidos.
Quando o restaurante cancela o pedido através do painel de pedidos da Goomer:
O PDV pode ser notificado a cada novo pedido. Esta é forma mais indicada de integração, pois possui o menor tempo de resposta.
Os webhooks cadastrados serão chamados à cada novo evento.
Para os casos onde PDV não possui uma API online para receber os eventos via webhook, ele pode utilizar o modelo de polling, fazendo chamadas para as rotas de consulta de novos pedidos e de pedidos cancelados periodicamente.
O diagrama abaixo exibe o fluxo de integração para receber pedidos via polling.
