Skip to main content
Este guia te leva pelos passos mínimos para ter uma integração funcionando com o Fire: receber eventos de pedido através de um Integration Flow e injetar pedidos via API REST.

Pré-requisitos

  • Credenciais de API do dashboard do Fire (veja Autenticação)
  • Um endpoint HTTPS acessível publicamente
  • Acesso ao dashboard em Settings → Integration Flows

Passo 1: Configurar um Integration Flow

No dashboard do Fire, vá em Settings → Integration Flows → New flow, e então:
  • Trigger: escolha order.completed
  • Escopo: account, vendor e opcionalmente lojas específicas
  • Nó HTTP: adicione um e configure
    • Método: POST
    • URL: seu endpoint HTTPS
    • Headers: Content-Type: application/json (mais qualquer header de auth — Bearer token / API key)
    • Body: cole o template canônico de exemplo que o dashboard inclui (produz { event, data, _meta })
  • Ative o flow
Para um walkthrough de 10 minutos com detalhe passo a passo, veja Tratar eventos de pedido.
Durante o desenvolvimento você pode usar uma ferramenta como ngrok para expor um servidor local à internet. Cole a URL HTTPS do ngrok como URL do nó HTTP do flow.

Passo 2: Identificadores de canal e serviço para pedidos

Se sua integração injeta pedidos, os objetos channel e service precisam de valores uid do Fire (e campos relacionados). Obtenha esses identificadores nos payloads de webhooks de publicação — por exemplo channel.updated e eventos relacionados — ou na configuração de integração e canais que você gerencia no painel Fire (veja Integrações de agregadores).

Passo 3: Tratar o evento

Seu endpoint vai receber requisições POST do seu flow toda vez que um pedido for completado. O formato do body é o que o template do body do seu flow renderiza. Com o template canônico, isso é:
Um handler mínimo:
Veja order.completed para a referência campo a campo do payload.

Passo 4: Injetar pedidos

Quando seu sistema receber um pedido (de um agregador ou qualquer outra fonte), injete-o no Fire.
Quando o pedido alcançar status=COMPLETED e paymentStatus=SUCCEEDED, seu flow dispara e seu handler roda. Se o pedido for cancelado depois, você receberá order.cancelled. Veja Injetar pedido para a referência completa do payload.

Passo 5: Adicionar eventos fiscais (apenas Brasil)

Se você opera no Brasil e tem emissão fiscal habilitada para uma loja, adicione um segundo flow com trigger order.invoiced (e outro com order.reversed) — mesmo endpoint HTTPS, mesmo template — para receber o contexto do documento fiscal.

Próximos passos

Tratar eventos de pedido

Walkthrough detalhado com auth e idempotência.

Visão geral de eventos

Envelope, headers, retentativas, dedup.

Referência order.completed

Esquema de payload completo com os blocos fiscais BR.

Referência da API

Injetar pedidos e chamar endpoints autenticados.