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

# Visão geral da API

> Endpoint base, formato das respostas e onde encontrar a referência completa de cada recurso.

A referência da API é gerada automaticamente a partir do nosso schema OpenAPI 3.1. Use o menu lateral para navegar pelos endpoints.

## Endpoint base

```
https://besimplo.com/api/v1
```

Todas as requisições autenticadas usam o header:

```http theme={null}
Authorization: ApiKey live_xxxxxxxxxxxxxxxx
```

[Saiba mais sobre autenticação](/guias/autenticacao).

## Formato

* **Requisições**: JSON (`Content-Type: application/json`).
* **Respostas**: JSON em UTF-8.
* **Datas**: ISO 8601 ou Unix timestamp em segundos (varia por campo — veja a referência).
* **Valores monetários**: inteiros em **centavos** (R\$ 99,90 = `9990`).
* **Moedas**: código ISO 4217 em maiúsculas (`BRL`).

## Recursos principais

<CardGroup cols={2}>
  <Card title="Clientes" icon="users" href="/api-reference/clientes/criar-novo-cliente">
    Cadastre e gerencie quem paga.
  </Card>

  <Card title="Produtos" icon="box" href="/api-reference/produtos/listar-produtos">
    Defina o que você vende.
  </Card>

  <Card title="Preços" icon="tag" href="/api-reference/preços/listar-preços">
    Configure quanto e com que frequência cobrar.
  </Card>

  <Card title="Assinaturas" icon="repeat" href="/api-reference/assinaturas/criar-nova-assinatura">
    Conecte clientes a planos recorrentes.
  </Card>

  <Card title="Faturas" icon="receipt" href="/api-reference/faturas/listar-todas-as-faturas">
    Liste e consulte cobranças geradas.
  </Card>

  <Card title="Reembolsos" icon="rotate-left" href="/api-reference/reembolsos/criar-reembolso">
    Devolva pagamentos total ou parcialmente.
  </Card>

  <Card title="Checkout" icon="credit-card" href="/api-reference/checkout/criar-nova-sessão-de-checkout">
    Páginas de pagamento hospedadas.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api-reference/webhooks/fatura-paga">
    Eventos enviados ao seu servidor.
  </Card>
</CardGroup>

## Schema OpenAPI

A definição completa está disponível como [OpenAPI 3.1 YAML](/api-reference/openapi.yml) — útil se você quer gerar clientes próprios, importar no Postman ou Insomnia.

## Convenções

* **IDs** seguem o padrão [TypeID](https://github.com/jetify-com/typeid): prefixo descritivo + ULID em base32 (`cus_01h455vb4pex5vsknk084sn02p`).
* **Recursos relacionados** retornam por `id` apenas — você expande chamando o endpoint do recurso quando precisar.
* **Paginação por cursor** em todos os endpoints de listagem. Veja [Paginação](/conceitos/paginacao).