🚀 V2 da API conta com Webhooks!

Fala, comunidade de devs! :purple_heart:

Cansados de fazer polling infinito para saber se aquele pedido novo chegou? Temos novidades: a V2 da API do aiqfome já conta com Webhooks, e a integração está mais simples do que nunca.

Agora, sua aplicação recebe notificações em tempo real sempre que algo importante acontece. Menos esforço para o servidor e muito mais agilidade para o lojista.


:package: O que você pode monitorar?

Dividimos os eventos para que você tenha controle total sobre a operação:

  • Ciclo do Pedido: new-order, read-order, ready-order, cancel-order e order-refund.
  • Configuração e Cardápio: new-store e new-menu.
  • Logística: order-logistic (acompanhe cada passo da entrega).

:shield: Segurança e Autenticação

Para garantir que a notificação veio mesmo da gente, todas as requisições acompanham headers específicos. O mais importante é o Authorization, onde enviamos a secret_key que você cadastrou.

Header Valor Descrição
User-Agent aiqfome Identifica a origem.
Content-Type application/json Formato do corpo da requisição.
Authorization <sua_secret_key> Chave secreta para validar a autenticidade.

Dica de mestre: O corpo da requisição (Body) é um JSON padronizado contendo o tipo de evento (event), o ID da loja (store_id) e o objeto com os dados detalhados (data).


:gear: Como começar?

É muito direto: com o token da loja em mãos, basta inscrever a sua URL de destino nos nossos endpoints de gerenciamento:

  1. Cadastrar: Envie um POST para a nossa rota de webhooks.
  2. Gerenciar: Você pode atualizar (PUT/PATCH) ou remover (DELETE) o webhook a qualquer momento através do ID: /store/{store_id}/webhooks/{id}.

Sua integração vai ficar mais rápida que entrega de lanche em dia de promoção! :hamburger::high_voltage:


:open_book: Documentação Completa

Para ver exemplos de payloads e o passo a passo detalhado, acesse nosso portal:

:link: Guia de Webhooks - aiqfome Developer

Dúvidas? Solta o verbo aqui nos comentários ou chama nosso suporte técnico!

1 curtida