Autenticação

Todas as rotas sob /v1 exigem uma API key no header Authorization usando o esquema Bearer.

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

Acesse Configurações → Avançado → API Keys.
Selecione Criar API key.
Dê um nome que identifique o consumidor, como Leme ou Claude Code.
Mantenha o acesso somente leitura para consultar os recursos desta versão.
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:

export BEVITS_API_KEY="bvt_live_..."

Em seguida, envie o header em todas as chamadas:

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

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();

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.

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key.",
    "request_id": "req_07f6cdc3c20249d6afcd90b4"
  }
}

Primeiros passos

Fundamentos

Referência

Autenticação

Criar uma chave

Usar a chave

Escopos

Revogar uma chave

​Criar uma chave

​Usar a chave

​Escopos

​Revogar uma chave

Criar uma chave

Usar a chave

Escopos

Revogar uma chave