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
Content-Type: application/json
Authorization: Bearer <token-ou-segredo-da-conexao>
X-Connect-Signature: sha256=<hmac>
X-Connect-Timestamp: 1710000000Referência
Catálogo e feed para IA
Todo produto publicado na loja online tem URL pública, SEO automático, Open Graph, canonical, schema.org Product e feed JSON para agentes. Isso permite que IAs e sistemas externos encontrem nome, descrição, preço, fotos, disponibilidade e link de compra.
Feed ACP
GET https://girabem.com.br/api/public/acp/{connection_token}
Resposta:
{
"protocol": "agentic-commerce-product-feed",
"store": { "name": "Minha Loja", "url": "https://..." },
"products": [
{
"id": "uuid",
"sku": "CAMISETA-P",
"title": "Camiseta Preta",
"description": "...",
"link": "https://.../produto/camiseta-preta",
"image_link": "https://.../foto.jpg",
"availability": "in_stock",
"price": "99.90 BRL",
"brand": "Minha Loja"
}
]
}Quando usar o assinado
Para agentes de WhatsApp, prefira o catálogo assinado quando precisar de variações e estoque em tempo real. Para descoberta por IA, use o feed ACP e as páginas públicas dos produtos.
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 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:
{
"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
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
| Evento | Grupo | Quando dispara |
|---|---|---|
sale.createdVenda criada | Vendas | Disparado quando uma nova venda/pedido é registrada (PDV, loja ou importação). |
sale.paidVenda paga | Vendas | Disparado quando uma venda é aprovada/paga. |
sale.cancelledVenda cancelada | Vendas | Disparado quando uma venda é cancelada. |
sale.fulfilledPedido enviado | Vendas | Disparado quando um pedido é marcado como enviado/expedido (com rastreio). |
stock.updatedEstoque movimentado | Estoque | Disparado a cada movimentação de estoque (entrada, saída, ajuste). |
fiscal.note.issuedNota fiscal emitida | Fiscal | Disparado quando uma nota fiscal (NF-e/NFC-e/NFS-e) é autorizada. |
fiscal.note.cancelledNota fiscal cancelada | Fiscal | Disparado quando uma nota fiscal é cancelada. |
fiscal.note.errorFalha na emissão fiscal | Fiscal | Disparado 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 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
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
Crie ou selecione o workspace correto.
Publique produtos na loja online.
Confira se as variações têm foto, SKU e estoque.
Configure domínio próprio da loja, quando houver.
Configure os pixels de Meta/Google/OpenAI na loja.
Só é necessário se você usa mídia paga ou IA comercial.
Crie endpoint de webhook e valide a assinatura HMAC.
Teste a criação de pedido com um produto real e uma variação real.
Confirme a resposta do pedido.
Ela precisa trazer
payment_urloupix_code.Monitore entregas e retentativas no painel de Webhooks & API.
Daqui para frente
Grupo atual: Começar