Documentação para humanos e agentes de IA

Integre o Gira Bem com qualquer API, webhook, agente de WhatsApp ou sistema externo.

Este guia explica, de forma direta, como ler catálogo, criar pedidos, receber eventos, sincronizar estoque e preparar produtos para mecanismos de busca e IAs como ChatGPT, Claude, Manus, Bling e outros conectores.

Começar

Visão geral

O Gira Bem centraliza produtos, variações, estoque, clientes, vendas, fiscal, pagamentos, loja online e webhooks. A integração ideal usa três blocos: API de catálogo, criação de pedidos e webhooks para eventos em tempo real.

Os três blocos


Começar

Conceitos principais

Vocabulário

  • Workspace: empresa/conta dentro do Gira Bem.
  • Loja online: vitrine pública nativa do Gira Bem, com slug e domínio próprio.
  • Produto: item principal, com imagens, categorias e preço base.
  • Variação: tamanho/cor/sabor/voltagem, com SKU, foto, preço e estoque próprios.
  • Estoque: pode vir do ERP base ou de loja/depósito separado.
  • Token de conexão: identifica a loja ou workspace para APIs públicas controladas.

Começar

Credenciais e segurança

No painel, acesse Webhooks & API para criar endpoints de saída, ver segredos HMAC e configurar recebimento. Para integrações de catálogo/pedido, use sempre tokens e assinatura.

Segredo nunca vai para o navegador

Nunca coloque segredos no frontend do seu agente. O token e o segredo HMAC ficam no servidor que fala com o Gira Bem — qualquer chave publicada no cliente é uma chave vazada.

Cabeçalhos comuns

cabeçalhos HTTP
Content-Type: application/json
Authorization: Bearer <token-ou-segredo-da-conexao>
X-Connect-Signature: sha256=<hmac>
X-Connect-Timestamp: 1710000000

Referência

Criar pedidos via integração

Use este fluxo quando um agente de WhatsApp, chatbot, CRM ou sistema externo fechar uma venda. O Gira Bem recalcula preço e estoque internamente; o integrador envia apenas IDs e quantidades.

A requisição

POST /api/public/orders
POST https://girabem.com.br/api/public/orders
Content-Type: application/json
X-Connect-Timestamp: 1710000000
X-Connect-Signature: sha256=<hmac_do_timestamp_e_body>

{
  "external_id": "whatsapp-5511999990000-1700000000",
  "customer": {
    "name": "Maria Silva",
    "email": "maria@email.com",
    "phone": "+5511999990000",
    "document": "12345678909"
  },
  "items": [
    { "product_id": "uuid-do-produto", "variant_id": "uuid-da-variacao", "quantity": 2 }
  ],
  "payment": {
    "method": "pix",
    "provider": "mercadopago"
  },
  "metadata": {
    "source": "agente-whatsapp",
    "conversation_id": "abc123"
  }
}

A resposta

Resposta esperada:

200 OK
{
  "ok": true,
  "order_id": "uuid-da-venda",
  "status": "pending",
  "payment_url": "https://checkout...",
  "pix_code": "000201...",
  "next_action": "send_pix_code"
}

O que fazer com a resposta

  • payment_url: envie ao cliente quando a forma for link/cartão/boleto.
  • pix_code: envie como copia-e-cola quando o pagamento for PIX.
  • next_action: indica se o agente deve mandar link, PIX ou orientar pagamento no caixa.

Referência

Webhooks de saída

Cadastre uma URL no painel para receber eventos. O Gira Bem envia POST com corpo JSON e assinatura HMAC.

Responda 2xx em até 10 segundos

Passou disso, a entrega conta como falha e o Gira Bem faz retentativas. Se o seu processamento é lento, responda 200 primeiro e processe depois.

Cabeçalhos e envelope

POST no seu endpoint
Headers enviados:
X-Listralize-Event: sale.paid
X-Listralize-Delivery: uuid-da-entrega
X-Listralize-Timestamp: 1710000000
X-Listralize-Signature: sha256=<hmac>

Envelope:
{
  "id": "uuid-da-entrega",
  "event": "sale.paid",
  "created_at": "2026-06-30T00:00:00.000Z",
  "data": { "id": "uuid-do-recurso", "status": "approved" }
}

Eventos disponíveis

EventoGrupoQuando dispara
sale.createdVenda criadaVendasDisparado quando uma nova venda/pedido é registrada (PDV, loja ou importação).
sale.paidVenda pagaVendasDisparado quando uma venda é aprovada/paga.
sale.cancelledVenda canceladaVendasDisparado quando uma venda é cancelada.
sale.fulfilledPedido enviadoVendasDisparado quando um pedido é marcado como enviado/expedido (com rastreio).
stock.updatedEstoque movimentadoEstoqueDisparado a cada movimentação de estoque (entrada, saída, ajuste).
fiscal.note.issuedNota fiscal emitidaFiscalDisparado quando uma nota fiscal (NF-e/NFC-e/NFS-e) é autorizada.
fiscal.note.cancelledNota fiscal canceladaFiscalDisparado quando uma nota fiscal é cancelada.
fiscal.note.errorFalha na emissão fiscalFiscalDisparado quando uma emissão fiscal é rejeitada ou retorna erro.

Referência

Recebimento de webhooks externos

Se outro sistema já tem webhooks, envie para a URL de recebimento do workspace. Isso registra eventos externos e permite criar automações internas depois.

A URL de recebimento

POST /api/public/webhooks/in/{token_do_workspace}
POST https://girabem.com.br/api/public/webhooks/in/{token_do_workspace}?source=meu-sistema&event=stock.changed
Content-Type: application/json

{ "product_id": "uuid", "variant_id": "uuid", "quantity": 12 }

Na prática

Pixels, Google e loja online

A loja online aceita configuração por workspace/loja para Meta Pixel, Google Analytics 4, Google Ads, conversões aprimoradas e OpenAI Ads Pixel. Os scripts são injetados no layout da loja e eventos como visualização, carrinho, checkout e compra são disparados no navegador e no backend quando aplicável.

O que configurar

  • Configure na edição da loja: Marketing e Pixels.
  • Use domínio próprio verificado para melhorar confiança, SEO e mensuração.
  • Produtos publicados geram metadata e JSON-LD automaticamente.

Na prática

Sugestões de uso

As mesmas quatro peças da referência — catálogo, pedido, webhook de saída e webhook de entrada — montam integrações bem diferentes. Seis que já rodam:

Seis integrações

Agente de WhatsApp próprio
Leia catálogo, mostre variações/fotos/estoque, crie pedido e envie PIX ou link de pagamento.
CRM ou atendimento
Receba eventos de venda, carrinho abandonado e solicitação de troca/cancelamento.
Gestão de estoque externa
Consuma webhooks de estoque e envie eventos externos para manter saldos alinhados.
BI e relatórios
Receba vendas aprovadas, itens, origem, pagamento e status fiscal em tempo real.
Marketplace ou app
Use produtos publicados e URLs canônicas para montar vitrines externas.
IA de compras
Use o feed ACP e páginas schema.org para descoberta e recomendação de produtos.

Na prática

Checklist de integração

Passe por esta lista antes de considerar a integração pronta. Ela é curta de propósito: cada item é uma coisa que, faltando, aparece como chamado no suporte.

Os oito passos

  1. Crie ou selecione o workspace correto.

  2. Publique produtos na loja online.

    Confira se as variações têm foto, SKU e estoque.

  3. Configure domínio próprio da loja, quando houver.

  4. Configure os pixels de Meta/Google/OpenAI na loja.

    Só é necessário se você usa mídia paga ou IA comercial.

  5. Crie endpoint de webhook e valide a assinatura HMAC.

  6. Teste a criação de pedido com um produto real e uma variação real.

  7. Confirme a resposta do pedido.

    Ela precisa trazer payment_url ou pix_code.

  8. Monitore entregas e retentativas no painel de Webhooks & API.

Daqui para frente

Grupo atual: Começar