Seja bem vindo developer!

Aqui você encontra mais detalhes sobre os recursos de integração (API e Web-hooks) da Foody Delivery.

API de Integração

A api da Foody Delivery é usada por nossos parceiros, geralmente sistemas de PDV ou captação de pedido online, para integrar seus sistemas com a Foody.

Veja um exemplo de um cenário comum de integração:

O pedido chega no PDV e depois de confirmado, o sistema PDV passa o pedido para Foody através da api.

Uma vez que o pedido está na Foody, o sistema de PDV recebe atualizações do pedido através dos nossos web-hooks ou fazendo um polling usando nossa api.

Documentação técnica da API

CLIQUE AQUI para fazer o download da documentação da versão mais atual (v1.2) da nossa API.

Documentação técnica dos web-hooks

Webhook é uma forma de integração entre dois sistemas onde um sistema notifica o outro quando um evento acontece.

No caso da Foody Delivery, os webhooks são muito úteis quando um sistema integrado à Foody Delivery quer receber informações sobre atualizações (notificações) sobre os pedidos. Exemplo: quando um pedido foi despachado para um motoboy ou entregue para o cliente.

Boas práticas no uso dos hooks

As chamadas dos webhook da Foody Delivery tem um timeout de 10 segundos, então evite grandes processamentos diretamente na URL que é chamada pelo hook.

A URL invocada pelo webhook deve sempre retornar http-status 200, qualquer status diferente de 200 será considerado um erro na chamada do hook.

Quando o hook encontra um erro (http-status diferente de 200), ele tenta mais uma vez depois de 60-120 segundos.

Se você precisa de uma ferramenta de apoio para desenvolver sua API (URL invocada pelos hooks) localmente e ainda receber as chamadas normalmente, nós recomendamos que você use a ferramenta ngrok.

Como configurar e ativar os webhooks

Acesse Minha Conta > Configurações Avançadas, então entre com a URL a ser invocada pelo hook e clique em Web-hook Ativado.

O payload enviado pelo hook contém um token (mesmo token usado também usado pela API da Foody) para que você autentique a chamada do hook.

Exemplo de payload:

{
“uid”: “4228df3a-a54a-40d7-b30f-1385eca4c3dd”,
“updateDate”: “2020-06-19T17:42:12Z”,
“event”: “order_status_updated”,
“token”: “2b100082b90d4ad9b4fezzed960cf652”,
“status”: “dispatched”
}

Fique informado

IMPORTANTE! Faça seu cadastro no formulário abaixo (exclusivo para developers) e saiba das novidades e atualizações da nossa api.