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

# Introdução

> Visão geral da API v1, base URL e como navegar na referência.

API pública para integrar **catálogo**, **pedidos**, **checkout marketing**, **webhooks**, **clientes** e **leads** da loja.

|              |                                                               |
| ------------ | ------------------------------------------------------------- |
| Base URL     | `https://apiv3.usecorvex.com.br`                              |
| Prefixo      | `/api/v1`                                                     |
| Autenticação | API Key `cvx_live_...` (não use JWT do painel)                |
| Loja         | Header `X-Store-Id` em toda requisição                        |
| Formato      | JSON com envelope `{ success, data }` ou `{ success, error }` |

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/authentication">
    Bearer, escopos e lojas permitidas.
  </Card>

  <Card title="Paginação" icon="list" href="/pagination">
    `page`, `limit` e metadados da lista.
  </Card>

  <Card title="Erros" icon="triangle-alert" href="/errors">
    Códigos HTTP e mensagens comuns.
  </Card>

  <Card title="Primeiros passos" icon="rocket" href="/quickstart">
    Da chave à primeira chamada.
  </Card>
</CardGroup>

## Como a referência está organizada

No menu lateral, os endpoints ficam em **pastas por área** (como Catálogo, Pedidos, Marketing). Abra a pasta do recurso e escolha o método HTTP.

| Pasta          | Recursos                                                                               |
| -------------- | -------------------------------------------------------------------------------------- |
| **Catálogo**   | Produtos, coleções (`/categories`), kits                                               |
| **Pedidos**    | Pedidos, rastreio, carrinhos abandonados                                               |
| **Clientes**   | Compradores e leads                                                                    |
| **Marketing**  | Order bumps, brindes, upsell, cupons, faixas e desconto por pagamento                  |
| **Checkout**   | [Criar checkout externo](/stores/external/checkout) (`x-api-key`, fora da v1)          |
| **Webhooks**   | [Payload HTTP](/webhooks-payloads) + [CRUD API v1](/api/v1/webhooks)                   |
| **Automações** | [CRUD + validate + templates](/automations) (`automations:read` / `automations:write`) |

Coleção na API = **categoria**. Cliente se consulta pelo **documento**. Pedido não se cria aqui (checkout). Cupom não se exclui — altere o `status`.