> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bevits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API

> 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.

<Info>
  **URL base:** `https://api.bevits.com/v1`
</Info>

## Primeira chamada

<Steps>
  <Step title="Crie uma API key">
    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.
  </Step>

  <Step title="Guarde a chave em uma variável de ambiente">
    ```bash theme={null}
    export BEVITS_API_KEY="bvt_live_..."
    ```
  </Step>

  <Step title="Consulte a identidade da conexão">
    ```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
    }
    ```
  </Step>
</Steps>

## O que está disponível

<CardGroup cols={2}>
  <Card title="Clientes" icon="users" href="/pt-BR/api-reference/overview#clientes-e-compras">
    Busque clientes, dados de contato, tags, atributos, métricas e compras.
  </Card>

  <Card title="Segmentos" icon="filter" href="/pt-BR/api-reference/overview#clientes-e-compras">
    Liste segmentos e consulte seus clientes.
  </Card>

  <Card title="Automações" icon="diagram-project" href="/pt-BR/api-reference/overview#marketing-e-automação">
    Consulte flows e o resumo das suas execuções.
  </Card>

  <Card title="Campanhas" icon="envelope" href="/pt-BR/api-reference/overview#marketing-e-automação">
    Consulte campanhas de e-mail e métricas agregadas.
  </Card>
</CardGroup>

### 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}` |

<Note>
  A API key determina automaticamente a organização. Não envie um ID de
  organização nas rotas desta versão.
</Note>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/pt-BR/api-reference/authentication">
    Crie, armazene e revogue credenciais com segurança.
  </Card>

  <Card title="Paginação e erros" icon="code" href="/pt-BR/api-reference/fundamentals">
    Entenda cursores, IDs, limites e respostas de erro.
  </Card>

  <Card title="Agentes de IA" icon="sparkles" href="/pt-BR/api-reference/ai-agents">
    Use a API com Leme, Claude Code, Codex e outros agentes.
  </Card>
</CardGroup>