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.
Catálogo
Produtos, fotos, variações, estoque, preço e links públicos.
Pedidos
Criação de pedido com PIX, link de pagamento ou pagamento no balcão.
Webhooks
Eventos de venda, estoque, fiscal, carrinho e solicitações.
Conceitos principais
- 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.
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. Nunca coloque segredos no frontend do seu agente.
Headers comuns:
Content-Type: application/json
Authorization: Bearer <token-ou-segredo-da-conexao>
X-Connect-Signature: sha256=<hmac>
X-Connect-Timestamp: 1710000000Catá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.
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"
}
]
}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.
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.
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"
}
}Resposta esperada:
{
"ok": true,
"order_id": "uuid-da-venda",
"status": "pending",
"payment_url": "https://checkout...",
"pix_code": "000201...",
"next_action": "send_pix_code"
}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.
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; caso contrário haverá retentativas.
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" }
}| Evento | Descrição | Tipo |
|---|---|---|
sale.created | Disparado quando uma nova venda/pedido é registrada (PDV, loja ou importação). | Varejo |
sale.paid | Disparado quando uma venda é aprovada/paga. | Varejo |
sale.cancelled | Disparado quando uma venda é cancelada. | Varejo |
sale.fulfilled | Disparado quando um pedido é marcado como enviado/expedido (com rastreio). | Varejo |
stock.updated | Disparado a cada movimentação de estoque (entrada, saída, ajuste). | Varejo |
fiscal.note.issued | Disparado quando uma nota fiscal (NF-e/NFC-e/NFS-e) é autorizada. | Varejo |
fiscal.note.cancelled | Disparado quando uma nota fiscal é cancelada. | Varejo |
fiscal.note.error | Disparado quando uma emissão fiscal é rejeitada ou retorna erro. | Varejo |
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.
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 }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, TikTok Pixel 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.
- 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.
Sugestões de uso
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.
Checklist de integração
- Crie ou selecione o workspace correto.
- Publique produtos na loja online e confira se variações têm foto, SKU e estoque.
- Configure domínio próprio da loja, quando houver.
- Configure pixels de Meta/Google/OpenAI na loja, se usar mídia paga ou IA comercial.
- Crie endpoint de webhook e valide assinatura HMAC.
- Teste criação de pedido com um produto real e uma variação real.
- Confirme que a resposta retorna
payment_urloupix_code. - Monitore entregas e retentativas no painel de Webhooks & API.