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

# Introdução

> O que é a PlugToPay, para quem é e como começar.

A PlugToPay é uma camada de orquestração de pagamentos que roteia transações entre múltiplos gateways (Pagarme, Safe2Pay, Asaas, PagBank e outros) com fallback automático, cofre de cartões agnóstico e entrega de webhooks com retenção.

## Para quem é esta documentação

Esta referência é voltada para desenvolvedores que integram diretamente com a API da PlugToPay via `X-API-Key`. Para o painel de gestão acesse [plugtopay.com/login](https://plugtopay.com/dashboard).

## Base URLs

| Ambiente      | URL                                                    |
| ------------- | ------------------------------------------------------ |
| Produção      | `https://api.plugtopay.com/api/v1`                     |
| Sandbox       | `https://sandbox-api.plugtopay.com/api/v1`             |
| BFF do painel | `/api/plugtopay` (proxy Next.js — somente uso interno) |

<Info>
  Todos os exemplos nesta documentação usam a URL de sandbox diretamente. O BFF é exclusivo para o painel administrativo e não deve ser usado em integrações externas.
</Info>

## Esquemas de autenticação

A API expõe três esquemas distintos:

| Esquema          | Header                          | Quem usa                                                                                                    |
| ---------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Sem autenticação | —                               | Cadastro, login e as rotas públicas de [links de pagamento](/payment-links#rotas-públicas-sem-autenticação) |
| API Key          | `X-Client-ID` + `X-API-Key`     | Integrações servidor-a-servidor                                                                             |
| Bearer JWT       | `Authorization: Bearer <token>` | Painel administrativo                                                                                       |

## Próximos passos

* [Autenticação](/authentication) — obtenha e gerencie suas credenciais.
* [Pagamentos](/payments) — crie transações com cartão ou PIX.
* [Checkout](/checkout) — sessão de checkout unificada com cartões salvos.
* [Links de pagamento](/payment-links) — cobre por uma URL compartilhável, sem escrever frontend.
* [Assinaturas](/subscriptions/overview) — planos recorrentes, ciclos e cupons.
* [Idempotência](/idempotency) — processe pagamentos com segurança em redes instáveis.
* [Webhooks](/webhooks) — receba notificações de eventos em tempo real.
* [Orquestração](/orchestration/overview) — roteamento inteligente entre gateways.
* [Status](/status-codes) — interprete os estados de cada transação.
* [Gateways](/gateways) — gateways suportados e lógica de roteamento.