> ## Documentation Index
> Fetch the complete documentation index at: https://fortal-pay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Bem-vindo à API da FortalPay

> Integre cobranças Pix, checkouts e os recursos do seu negócio com uma API simples e segura.

A documentação para integrar a FortalPay ao seu sistema, criar experiências de pagamento e gerenciar os dados do seu negócio.

<CardGroup cols={2}>
  <Card title="Faça sua primeira requisição" icon="rocket" href="/quickstart">
    Configure sua API key e valide a integração em poucos passos.
  </Card>

  <Card title="Explore a referência da API" icon="square-terminal" href="/api-reference/create-checkout">
    Consulte endpoints, parâmetros, exemplos e respostas.
  </Card>
</CardGroup>

***

## O que é a FortalPay?

A FortalPay oferece uma API para criar cobranças Pix e páginas de checkout hospedadas. Clientes, produtos e cupons podem ser gerenciados pela mesma integração, enquanto webhooks notificam seu sistema sobre eventos de pagamento.

Uma requisição mínima para criar um checkout usa os produtos cadastrados no seu catálogo:

```bash theme={null}
curl --request POST 'https://api.fortalpay.com/v1/checkouts' \
  --header 'Authorization: ApiKey fpay_sk_test_...' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "quantity": 1
      }
    ]
  }'
```

### Princípios da API

<CardGroup cols={3}>
  <Card title="Previsível" icon="route">
    Recursos organizados em endpoints HTTP versionados, como `POST /v1/checkouts`.
  </Card>

  <Card title="Consistente" icon="braces">
    Respostas seguem o envelope `{ data, success, error }` em toda a API.
  </Card>

  <Card title="Segura" icon="shield-check">
    API keys autenticam as chamadas e webhooks usam assinatura HMAC-SHA256.
  </Card>
</CardGroup>

***

## O que você pode fazer

<CardGroup cols={3}>
  <Card title="Receber via Pix" icon="qr-code" href="/guides/charges">
    Crie cobranças Pix idempotentes e consulte os pagamentos do seu negócio.
  </Card>

  <Card title="Criar checkouts" icon="shopping-cart" href="/guides/checkouts">
    Gere páginas de pagamento hospedadas e redirecione seus clientes.
  </Card>

  <Card title="Gerenciar clientes" icon="users" href="/guides/customers">
    Cadastre, consulte, filtre e remova clientes da sua integração.
  </Card>

  <Card title="Organizar produtos" icon="package" href="/guides/products">
    Mantenha um catálogo de produtos para usar em cobranças e checkouts.
  </Card>

  <Card title="Aplicar cupons" icon="ticket-percent" href="/guides/coupons">
    Crie descontos percentuais ou fixos com validade e limite de uso.
  </Card>

  <Card title="Receber webhooks" icon="webhook">
    Acompanhe eventos em tempo real com entregas identificadas e assinadas.
  </Card>
</CardGroup>

***

## Primeiros passos

<CardGroup cols={2}>
  <Card title="1. Crie uma API key" icon="key-round" href="/authentication">
    Gere uma credencial de sandbox ou produção e armazene-a com segurança.
  </Card>

  <Card title="2. Faça uma requisição" icon="terminal" href="/quickstart">
    Autentique sua aplicação e confirme o acesso à API.
  </Card>

  <Card title="3. Conheça as convenções" icon="book-open" href="/guides/api-conventions">
    Entenda autenticação, ambientes, paginação e envelopes de resposta.
  </Card>

  <Card title="4. Crie um checkout" icon="badge-dollar-sign" href="/api-reference/create-checkout">
    Use os recursos cadastrados para iniciar sua primeira experiência de pagamento.
  </Card>
</CardGroup>

<Info>
  Use chaves `fpay_sk_test_...` durante o desenvolvimento e `fpay_sk_live_...` somente em produção. Chamadas de escrita exigem uma API key com acesso `FULL_ACCESS`.
</Info>