Visão geral da API

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

Crie uma API key

Acesse Configurações → Avançado → API Keys, crie uma chave com acesso de leitura e copie o segredo. Ele é exibido apenas uma vez.

Guarde a chave em uma variável de ambiente

export BEVITS_API_KEY="bvt_live_..."

Consulte a identidade da conexão

curl --request GET \
  --url https://api.bevits.com/v1/me \
  --header "Authorization: Bearer $BEVITS_API_KEY"

{
  "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

Clientes

Busque clientes, dados de contato, tags, atributos, métricas e compras.

Segmentos

Liste segmentos e consulte seus clientes.

Automações

Consulte flows e o resumo das suas execuções.

Campanhas

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

Autenticação

Crie, armazene e revogue credenciais com segurança.

Paginação e erros

Entenda cursores, IDs, limites e respostas de erro.

Agentes de IA

Use a API com Leme, Claude Code, Codex e outros agentes.

Primeiros passos

Fundamentos

Referência

Visão geral da API

Primeira chamada

O que está disponível

Clientes

Segmentos

Automações

Campanhas

Clientes e compras

Marketing e automação

Próximos passos

Autenticação

Paginação e erros

Agentes de IA

​Primeira chamada

​O que está disponível

Clientes

Segmentos

Automações

Campanhas

​Clientes e compras

​Marketing e automação

​Próximos passos

Autenticação

Paginação e erros

Agentes de IA

Primeira chamada

O que está disponível

Clientes e compras

Marketing e automação

Próximos passos