# Consultar flow Source: https://docs.bevits.com/api-reference/automações/consultar-flow /openapi.json get /v1/flows/{flow_id} Retorna status, gatilho, origem e contagem de execuções de um flow. # Listar flows Source: https://docs.bevits.com/api-reference/automações/listar-flows /openapi.json get /v1/flows Lista flows de automação, ordenados por atualização mais recente. # Consultar campanha de e-mail Source: https://docs.bevits.com/api-reference/campanhas/consultar-campanha-de-e-mail /openapi.json get /v1/email-campaigns/{email_campaign_id} Retorna agendamento, envio e métricas agregadas de uma campanha. # Listar campanhas de e-mail Source: https://docs.bevits.com/api-reference/campanhas/listar-campanhas-de-e-mail /openapi.json get /v1/email-campaigns Lista campanhas de e-mail, ordenadas por atualização mais recente. # Consultar cliente Source: https://docs.bevits.com/api-reference/clientes/consultar-cliente /openapi.json get /v1/customers/{customer_id} Retorna contato, métricas, tags, atributos e endereço padrão de um cliente. # Listar clientes Source: https://docs.bevits.com/api-reference/clientes/listar-clientes /openapi.json get /v1/customers Lista clientes da organização com filtros de identidade, assinatura, período, tag e segmento. # Listar compras do cliente Source: https://docs.bevits.com/api-reference/clientes/listar-compras-do-cliente /openapi.json get /v1/customers/{customer_id}/purchases Lista as compras de um cliente específico. # Consultar compra Source: https://docs.bevits.com/api-reference/compras/consultar-compra /openapi.json get /v1/purchases/{purchase_id} Retorna valores, estados, cupons e atribuição de flow de uma compra. # Listar compras Source: https://docs.bevits.com/api-reference/compras/listar-compras /openapi.json get /v1/purchases Lista compras com filtros por cliente, status, plataforma, período e valor. # Consultar tag Source: https://docs.bevits.com/api-reference/dados-do-crm/consultar-tag /openapi.json get /v1/tags/{tag_id} Retorna nome, cor e data de criação de uma tag. # Listar atributos Source: https://docs.bevits.com/api-reference/dados-do-crm/listar-atributos /openapi.json get /v1/attributes Lista as definições de atributos customizados de clientes. # Listar tags Source: https://docs.bevits.com/api-reference/dados-do-crm/listar-tags /openapi.json get /v1/tags Lista tags de clientes da organização. # Consultar identidade Source: https://docs.bevits.com/api-reference/identidade/consultar-identidade /openapi.json get /v1/me Retorna a organização vinculada à API key e os escopos da credencial. # Consultar segmento Source: https://docs.bevits.com/api-reference/segmentos/consultar-segmento /openapi.json get /v1/segments/{segment_id} Retorna os dados de um segmento. # Listar clientes do segmento Source: https://docs.bevits.com/api-reference/segmentos/listar-clientes-do-segmento /openapi.json get /v1/segments/{segment_id}/customers Lista clientes pertencentes ao segmento e permite ordená-los por valor total comprado. # Listar segmentos Source: https://docs.bevits.com/api-reference/segmentos/listar-segmentos /openapi.json get /v1/segments Lista segmentos de clientes, ordenados por atualização mais recente. # Verificar disponibilidade Source: https://docs.bevits.com/api-reference/sistema/verificar-disponibilidade /openapi.json get /health Retorna o estado básico do serviço. Não exige autenticação. # Agentes de IA Source: https://docs.bevits.com/pt-BR/api-reference/ai-agents Conecte a API da Bevits à Leme, Claude Code, Codex e outros agentes. Agentes podem usar a API REST da Bevits para responder perguntas sobre clientes, segmentos, compras, flows e campanhas. Cada API key acessa somente os dados da organização à qual pertence. Dê ao agente uma chave exclusiva com escopo `read`. Não cole a chave no prompt, em arquivos versionados ou em logs; disponibilize-a por uma variável de ambiente ou pelo gerenciador de segredos da plataforma. ## Leme Ao criar uma conexão personalizada na Leme, use: | Configuração | Valor | | --------------- | ----------------------------------------------------- | | URL base | `https://api.bevits.com/v1` | | Autenticação | API key / Bearer token | | Header | `Authorization: Bearer ` | | Identidade | `GET /me` | | Discovery | `GET /segments`, `GET /flows`, `GET /email-campaigns` | | Tipo da conexão | Compartilhada pela organização | Valide primeiro a conexão em `GET /me`. O `organization.id` retornado é a identidade estável da conexão. ## Claude Code e Codex Claude Code e Codex conseguem testar a API usando suas ferramentas de terminal. A API da Bevits é REST; ela não se apresenta diretamente como um servidor MCP. Inicie a ferramenta com a variável disponível no ambiente: ```bash theme={null} export BEVITS_API_KEY="bvt_live_..." ``` Em seguida, use uma instrução como: ```text theme={null} Use a API Bevits em https://api.bevits.com/v1. Autentique com Authorization: Bearer $BEVITS_API_KEY sem imprimir a chave. Comece consultando /me. Use paginação por starting_after e respeite X-RateLimit-* e Retry-After. Faça apenas operações de leitura. ``` ## Fluxo recomendado para CRM Para responder “quem são os melhores clientes do segmento VIP e o que eles compraram?”, o agente pode usar apenas três etapas: 1. `GET /segments?q=VIP` para localizar o segmento. 2. `GET /segments/{segment_id}/customers?sort=total_spent` para ordenar seus clientes. 3. `GET /customers/{customer_id}/purchases` para consultar as compras do cliente escolhido. Oriente o agente a conservar IDs exatamente como foram retornados e a pedir confirmação humana antes de qualquer ação fora dos endpoints de leitura. # Autenticação Source: https://docs.bevits.com/pt-BR/api-reference/authentication Autentique requisições com uma API key vinculada à sua organização. Todas as rotas sob `/v1` exigem uma API key no header `Authorization` usando o esquema Bearer. ```http theme={null} Authorization: Bearer bvt_live_... ``` Nunca envie a API key na URL, em parâmetros de query, no código-fonte ou em mensagens de suporte. Trate-a como uma senha. ## Criar uma chave 1. Acesse [Configurações → Avançado → API Keys](https://app.bevits.com/settings/api-keys). 2. Selecione **Criar API key**. 3. Dê um nome que identifique o consumidor, como `Leme` ou `Claude Code`. 4. Mantenha o acesso **somente leitura** para consultar os recursos desta versão. 5. Copie e armazene o segredo imediatamente. Ele não será exibido novamente. Somente owners e administradores da organização podem gerenciar API keys. ## Usar a chave Salve a credencial no gerenciador de segredos da sua plataforma ou em uma variável de ambiente local: ```bash theme={null} export BEVITS_API_KEY="bvt_live_..." ``` Em seguida, envie o header em todas as chamadas: ```bash cURL theme={null} curl --request GET \ --url https://api.bevits.com/v1/segments \ --header "Authorization: Bearer $BEVITS_API_KEY" ``` ```javascript Node.js theme={null} const response = await fetch("https://api.bevits.com/v1/segments", { headers: { Authorization: `Bearer ${process.env.BEVITS_API_KEY}`, }, }); if (!response.ok) { throw new Error(`Bevits API returned ${response.status}`); } const page = await response.json(); ``` ```python Python theme={null} import os import requests response = requests.get( "https://api.bevits.com/v1/segments", headers={"Authorization": f"Bearer {os.environ['BEVITS_API_KEY']}"}, timeout=30, ) response.raise_for_status() page = response.json() ``` ## Escopos | Escopo | Permite | | ------- | ------------------------------------------------------------------------------------------ | | `read` | Consultar identidade, clientes, compras, segmentos, tags, atributos, flows e campanhas. | | `write` | Reservado para operações de escrita. Não é necessário para os endpoints de leitura atuais. | Use sempre o menor privilégio necessário. Para Leme e agentes que apenas consultam dados, uma chave com `read` é suficiente. ## Revogar uma chave Revogue imediatamente uma chave que tenha sido exposta ou não seja mais usada. Na mesma página de API Keys, selecione a credencial e confirme **Revogar**. Chamadas posteriores passam a receber `401 authentication_error`. ```json theme={null} { "error": { "type": "authentication_error", "message": "Invalid API key.", "request_id": "req_07f6cdc3c20249d6afcd90b4" } } ``` # Fundamentos Source: https://docs.bevits.com/pt-BR/api-reference/fundamentals Convenções de paginação, filtros, IDs, cache, rate limit e erros da API. ## Paginação por cursor As listagens usam paginação por cursor e retornam `data` e `has_more`. O limite padrão é 25 itens e pode variar de 1 a 100. ```json theme={null} { "data": [ { "object": "segment", "id": "seg_ckxyz123", "name": "Clientes VIP" } ], "has_more": true } ``` Para buscar a página seguinte, envie o `id` do último item como `starting_after`: ```bash theme={null} curl --get https://api.bevits.com/v1/segments \ --header "Authorization: Bearer $BEVITS_API_KEY" \ --data-urlencode "limit=25" \ --data-urlencode "starting_after=seg_ckxyz123" ``` Continue enquanto `has_more` for `true`. Não reutilize o cursor de um tipo de recurso em outra listagem. ## IDs públicos IDs são opacos e carregam um prefixo que identifica o recurso. | Prefixo | Recurso | | ------- | ------------------ | | `org_` | Organização | | `bak_` | API key | | `cus_` | Cliente | | `seg_` | Segmento | | `pur_` | Compra | | `tag_` | Tag | | `atr_` | Atributo | | `flw_` | Flow | | `emc_` | Campanha de e-mail | Trate IDs como strings. Não remova o prefixo nem tente inferir seu conteúdo. ## Filtros e datas Filtros são enviados como parâmetros de query. Datas usam ISO 8601 com offset; as respostas são normalizadas para UTC. ```bash theme={null} curl --get https://api.bevits.com/v1/customers \ --header "Authorization: Bearer $BEVITS_API_KEY" \ --data-urlencode "is_subscribed=true" \ --data-urlencode "updated_since=2026-07-01T00:00:00Z" ``` Campos sem valor são omitidos das respostas, em vez de retornarem `null`. Valores monetários usam centavos, como `total_spent_in_cents: 15990`. ## Erros Erros nunca são retornados com status `200`. O campo `error.type` é estável para automação; `message` é legível por humanos; `request_id` identifica a requisição para suporte. ```json theme={null} { "error": { "type": "validation_error", "message": "Invalid input: expected number, received NaN", "param": "limit", "request_id": "req_07f6cdc3c20249d6afcd90b4" } } ``` | HTTP | `error.type` | Significado | | ----- | ---------------------- | ---------------------------------------------------- | | `400` | `invalid_request` | Rota, cursor ou formato da requisição inválido. | | `401` | `authentication_error` | API key ausente, inválida, expirada ou revogada. | | `403` | `permission_denied` | A credencial não possui a permissão necessária. | | `404` | `not_found` | O recurso não existe ou não pertence à organização. | | `409` | `conflict` | A requisição conflita com o estado atual do recurso. | | `422` | `validation_error` | Um parâmetro ou valor não passou pela validação. | | `429` | `rate_limited` | O limite de requisições foi excedido. | | `500` | `internal_error` | Erro inesperado no servidor. | ## Rate limit O limite inicial é de **600 requisições por minuto, por API key**. As respostas autenticadas incluem: ```http theme={null} X-RateLimit-Limit: 600 X-RateLimit-Remaining: 599 X-RateLimit-Reset: 2026-07-25T21:31:00.000Z ``` Ao receber `429`, aguarde o número de segundos indicado em `Retry-After` antes de tentar novamente. Use backoff com jitter em integrações automatizadas. ## Cache condicional Respostas de recursos incluem `ETag`. Envie esse valor em `If-None-Match` para evitar transferir novamente um conteúdo que não mudou: ```http theme={null} If-None-Match: "v1-4ad31f5efb6b8f35" ``` Quando o conteúdo for idêntico, a API responde `304 Not Modified` sem corpo. # Visão geral da API Source: https://docs.bevits.com/pt-BR/api-reference/overview Consulte dados de CRM e automação da sua organização pela API da Bevits. A API pública da Bevits permite que integrações e agentes de IA consultem os dados de uma organização. A primeira versão é **somente leitura** e usa uma API key vinculada à organização. **URL base:** `https://api.bevits.com/v1` ## Primeira chamada Acesse [Configurações → Avançado → API Keys](https://app.bevits.com/settings/api-keys), crie uma chave com acesso de leitura e copie o segredo. Ele é exibido apenas uma vez. ```bash theme={null} export BEVITS_API_KEY="bvt_live_..." ``` ```bash theme={null} curl --request GET \ --url https://api.bevits.com/v1/me \ --header "Authorization: Bearer $BEVITS_API_KEY" ``` ```json theme={null} { "object": "identity", "organization": { "id": "org_ckxyz123", "name": "Minha loja" }, "api_key": { "id": "bak_ckkey123", "name": "Integração", "scopes": ["read"] }, "livemode": true } ``` ## O que está disponível Busque clientes, dados de contato, tags, atributos, métricas e compras. Liste segmentos e consulte seus clientes. Consulte flows e o resumo das suas execuções. Consulte campanhas de e-mail e métricas agregadas. ### Clientes e compras | Recurso | Endpoints principais | | ------------------ | ------------------------------------------------------- | | Clientes | `GET /customers`, `GET /customers/{customer_id}` | | Compras do cliente | `GET /customers/{customer_id}/purchases` | | Segmentos | `GET /segments`, `GET /segments/{segment_id}/customers` | | Compras | `GET /purchases`, `GET /purchases/{purchase_id}` | | Tags e atributos | `GET /tags`, `GET /attributes` | ### Marketing e automação | Recurso | Endpoints principais | | ------------------- | ------------------------------------------------------------------ | | Flows | `GET /flows`, `GET /flows/{flow_id}` | | Campanhas de e-mail | `GET /email-campaigns`, `GET /email-campaigns/{email_campaign_id}` | A API key determina automaticamente a organização. Não envie um ID de organização nas rotas desta versão. ## Próximos passos Crie, armazene e revogue credenciais com segurança. Entenda cursores, IDs, limites e respostas de erro. Use a API com Leme, Claude Code, Codex e outros agentes. # Bling Source: https://docs.bevits.com/pt-BR/bling Integração com a Bling Integração da Bevits com a Bling Integração da Bevits com a Bling ## Como integrar a Bling com o Bevits? 1. Acesse o site da Bevits e crie uma conta ![Imagem da página de cadastro da Bevits](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-10-27%20at%2008.56.20%402x.png) 2. No primeiro passo do cadastro, forneças as informações da sua loja ![Imagem da página de cadastro da Bevits](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-10-27%20at%2008.57.45%402x.png) 3. Após entrar com os dados de pagamento, você será redirecionado para o passo 3 - "Conectar sua loja" ![Imagem da página de cadastro da Bevits](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-10-27%20at%2008.58.10%402x.png) 4. Clique em "Conectar loja" ![Imagem da página de cadastro da Bevits](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-10-27%20at%2008.58.25%402x.png) 5. Você será redirecionado para a página de integração com a Bling, é só clicar em "Autorizar" Isso irá autorizar o aplicativo a obter os tokens e se comunicar com sua conta Bling. A partir desse momento, todas as configurações no Bling estão finalizadas. 6. Após autorizar, você será redirecionado de volta para a Bevits, agora sua conta Bling está conectada com a Bevits e pronta para ser usada. Nossa equipe irá entrar em contato para te ajudas a cadastrar suas primeiras automações! 🙌 ### Suporte Para dúvidas sobre configuração ou otimização da campanha de WhatsApp, entre em contato conosco em **[hey@bevits.com](mailto:hey@bevits.com)**. # Changelog Source: https://docs.bevits.com/pt-BR/changelog Acompanhe as novidades e atualizações da plataforma Bevits ## 2026 ### Março As conversas agora são atribuídas automaticamente ao atendente mais adequado, com roteamento inteligente baseado em disponibilidade e histórico. O sistema também lembra o agente preferido de cada cliente para manter a continuidade do atendimento. Melhorias nas campanhas oficiais do WhatsApp: agora você pode selecionar imagens de cabeçalho, visualizar o status de aprovação dos templates com badges visuais, e receber reembolso automático de créditos quando um envio falhar. ### Fevereiro A Bevits agora se integra com a Shopify! Conecte sua loja Shopify para sincronizar clientes, produtos e pedidos — e crie automações baseadas em eventos como pedido pago, checkout abandonado e cliente criado. Agora você pode enviar vídeos diretamente nas conversas do chat, com upload e renderização completa das mensagens de vídeo. Todas as páginas de configurações agora possuem suporte completo ao modo escuro. ### Janeiro Lançamos o novo inbox de WhatsApp integrado à plataforma. Agora você consegue gerenciar todas as conversas com seus clientes direto pela Bevits — com busca, menu de contexto, deeplinks, início de novas conversas e reengajamento automático de conversas expiradas (fora da janela de 24h do WhatsApp). Organize seu atendimento com times. Agora você pode criar equipes, atribuir membros e direcionar conversas para o time responsável — garantindo que cada cliente seja atendido pela pessoa certa. As respostas rápidas agora suportam templates com imagens e botões interativos, tornando o atendimento mais ágil e profissional. Agora você pode enviar imagens diretamente nas conversas do chat, com pré-visualização antes do envio. Nova seção nas configurações da loja para visualizar e gerenciar os aprendizados da IA. Veja o que o agente aprendeu nas conversas e edite ou remova conhecimentos conforme necessário. O agente de IA agora consegue buscar produtos pelo catálogo usando imagens enviadas pelos clientes, facilitando recomendações mais precisas. *** ## 2025 ### 22 de Dezembro Agora você consegue ver direto no dashboard da Bevits os dados de recuperação de carrinhos abandonados. Quantos carrinhos foram recuperados e quanto isso representou financeiramente para a sua loja. ![Dados de Carrinhos Abandonados](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-12-22%20at%2012.10.32%402x.png) ### 15 de Dezembro Agora dentro de uma automação você tem o bloco de tags para adicionar ou remover tags aos clientes. Isso é útil para melhorar a segmentação de seus clientes e criar campanhas mais personalizadas. Exemplo:

Uma marca de shampoos pode criar tags automáticas baseadas no produto comprado, como "cabelos cacheados", "cabelos oleosos" ou "cabelos secos" — permitindo campanhas específicas para cada tipo de cliente. ### 8 de Dezembro Agora você consegue filtrar seus clientes (e criar segmentos personalizados) com base em produtos e categorias comprados. Isso é útil para criar campanhas mais personalizadas e direcionadas aos seus clientes. Exemplo:

Uma loja de roupas pode criar uma campanha para clientes que compraram produtos de uma determinada categoria, como "camisetas", "calças" ou "shorts" — permitindo campanhas específicas para cada tipo de cliente. ![Filtro por Produtos e Categorias](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/Screenshot%202025-12-22%20at%2012.05.29.png) ### Outubro Agora você pode criar automações para quando um pedido for marcado como entregue na Nuvemshop. Nem todas as lojas Nuvemshop possuem essa informação disponível. Se você não está vendo esse gatilho nas suas automações, pode enviar uma mensagem para o suporte para conferirmos. Uma campanha de WhatsApp agora pode ter mais de uma variação de mensagem, tornando o envio de campanhas mais seguro e reduzindo o risco de bloqueios. ![Variações de Mensagem](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/CleanShot%202025-11-03%20at%2009.05.01%402x.png) Para lojas que usam Nuvemshop junto com a Bling, agora você consegue fazer a baixa automaticamente do cupom gerado na Nuvemshop através da Bling. Basta digitar `cupom:nuvemshop:colocar_codigo_do_cupom_aqui` no campo de **Observações internas** na Bling. Agora você consegue filtrar seus clientes com base no DDD do número de telefone salvo. Basta selecionar **"Número de telefone"** + **"Começa com"** e adicionar o DDD desejado. Adicionamos 2 novos designs de footer nos componentes de email, facilitando a criação de emails bonitos e profissionais. ### 7 de Setembro Agora você pode visualizar o conteúdo da mensagem que foi enviada para o cliente em uma automação. ![Preview da Mensagem](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/Screenshot%202025-09-08%20at%2011.42.12.png) Dsponibilizamos a variável de nome dos produtos para você usar em suas automações. Isso faz com que as mensagens fiquem mais personalizadas e atraentes para o cliente. ![Nomes dos Produtos](https://pub-53ae48a3cb9144c4b561fc9617c1aa48.r2.dev/Screenshot%202025-09-08%20at%2011.48.05.png) ### 5 de Setembro Agora você tem mais um canal para criar automações de mensagens para seus clientes (principalmente para os que compram em sua loja física). Uma das automações mais poderosas (e aguardadas) é a possibilidade de criar programas de Giftback para seus clientes que compram em sua loja física. ### 3 de Setembro O CRM é um dos nosso maiores xodós aqui na Bevits. E pensando em melhorar ainda mais a sua experiência (e te ajudar a estar ainda mais próximo dos seus clientes), criamos filtros por cidade e estado para você criar segmentações de clientes que moram em uma localidade específica. [📖 Ver documentação completa do filtro de cidade e estado](/pt-BR/features/segmentos-personalizados) ### 23 de Agosto Agora ao enviar uma mensagem ou um email, você pode usar variáveis de entrega para personalizar a mensagem para o cliente. ![Delivery Variables](https://imagedelivery.net/Zfyk64sRe26oWRokEfeV9w/404ea1cb-fa49-4344-1a37-f2e60a12b600/public) ### 11 de Agosto Agora você consegue acompanhar o resultado de uma campanha de WhatsApp enviada, sabendo exatamente quais clientes compraram em até 72 horas após o recebimento da mensagem da campanha. ![WhatsApp Metrics](https://imagedelivery.net/Zfyk64sRe26oWRokEfeV9w/8ef65c7a-a0fe-43a4-fee8-20c4a4bce300/public) ### 29 de Julho Agora você pode recompensar seus clientes automaticamente com créditos de volta em suas compras! O Giftback chegou para aumentar o engajamento e fidelização na sua loja. [📖 Ver documentação completa do Giftback](/pt-BR/features/giftback) #### Novidades * ✨ **Giftback**: Recompense seus clientes automaticamente com créditos de volta em suas compras! Para suporte ou dúvidas sobre atualizações, entre em contato conosco em [hey@bevits.com](mailto:hey@bevits.com) # CRM Source: https://docs.bevits.com/pt-BR/features/CRM Gerencie suas vendas e clientes com o CRM da Bevits. ### O que é o CRM? O **CRM** é uma ferramenta que permite às lojas gerenciar suas vendas e clientes com base em suas preferências, compras e comportamentos. ### Como usar o CRM da Bevits?