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

# Introdução

## Bem-vindo à API da Pluggou

Bem-vindo à documentação oficial da API da **Pluggou**! Nossa API foi desenvolvida para oferecer uma integração robusta, segura e intuitiva com a nossa plataforma de intermediação de pagamentos.

Nossa plataforma foi pensada para simplificar o processo de integração, permitindo que você foque no que realmente importa: o seu negócio. Seja você um desenvolvedor construindo uma aplicação do zero ou uma equipe técnica integrando a Pluggou a um sistema já existente, esta documentação vai guiar você em cada etapa.

<Note>
  Antes de começar, certifique-se de que você possui uma conta ativa na Pluggou e suas credenciais de acesso à API. Caso ainda não tenha, acesse o [Dashboard](https://pluggoucash.com) para criar sua conta.
</Note>

***

## Explore a documentação

Navegue pelos módulos abaixo para conhecer cada aspecto da integração com a Pluggou:

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/api-reference/authentication">
    Saiba como gerar suas chaves de API e autenticar suas requisições com segurança.
  </Card>

  <Card title="Webhooks" icon="bell" href="/api-reference/webhooks">
    Entenda como receber notificações em tempo real sobre eventos da sua conta.
  </Card>

  <Card title="Gere sua primeira venda" icon="cart-shopping" href="/api-reference/transactions/create-pix">
    Crie sua primeira transação PIX e receba o código copia e cola para pagamento.
  </Card>

  <Card title="Solicite um saque" icon="money-bill-transfer" href="/api-reference/transactions/guide">
    Transfira o saldo da sua conta para sua conta bancária de forma rápida e segura.
  </Card>
</CardGroup>

***

## Padrões técnicos

Nossa API segue os princípios **RESTful**, com endpoints organizados por recursos e uso dos verbos HTTP padrão (`GET`, `POST`, `PUT`, `DELETE`) para manipulação dos dados. Utilizamos códigos de status HTTP para indicar o sucesso ou falha das operações, facilitando o tratamento de erros na sua aplicação.

### Formato de dados

Todas as requisições e respostas são formatadas em **JSON** (`application/json`), inclusive mensagens de erro. Isso garante uma padronização que facilita o parsing e a integração com qualquer linguagem de programação.

```json theme={null}
{
    "success": true,
    "message": "Mensagem descritiva",
    "data": { ... }
}
```

### CORS

Oferecemos suporte completo a **CORS** (Cross-Origin Resource Sharing), permitindo chamadas seguras diretamente de aplicações web hospedadas em outros domínios. Isso significa que você pode consumir a API tanto de um backend quanto de um frontend sem restrições de origem.

### Versionamento

A API da Pluggou é versionada para garantir compatibilidade com integrações existentes. Sempre que houver mudanças significativas, uma nova versão será disponibilizada, e versões anteriores continuarão funcionando por um período de transição.

***

## Ambiente da API

A Pluggou opera exclusivamente em **ambiente de produção**. Todas as requisições feitas à API refletem operações reais com movimentação financeira.

| Ambiente     | URL base                          | Descrição                              |
| ------------ | --------------------------------- | -------------------------------------- |
| **Produção** | `https://api.pluggoutech.com/api` | Ambiente único para todas as operações |

<Warning>
  **Atenção:** não possuímos ambiente de sandbox ou homologação. Toda requisição enviada à API será processada em produção com dados e transações reais. Tenha o máximo de cuidado durante a integração — valide bem seus payloads, teste a lógica da sua aplicação internamente antes de disparar chamadas para a API, e utilize valores baixos em transações de teste sempre que possível.
</Warning>

***

## Tratamento de erros

A API retorna códigos de status HTTP padronizados para indicar o resultado de cada operação. Em caso de erro, o corpo da resposta sempre inclui uma mensagem descritiva para facilitar a identificação do problema.

| Código | Significado           | Descrição                                      |
| ------ | --------------------- | ---------------------------------------------- |
| `200`  | OK                    | Requisição processada com sucesso              |
| `201`  | Created               | Recurso criado com sucesso                     |
| `400`  | Bad Request           | Parâmetros inválidos ou ausentes na requisição |
| `401`  | Unauthorized          | Token de autenticação ausente ou inválido      |
| `403`  | Forbidden             | Sem permissão para acessar o recurso           |
| `404`  | Not Found             | Recurso não encontrado                         |
| `422`  | Unprocessable Entity  | Dados da requisição não passaram na validação  |
| `429`  | Too Many Requests     | Limite de requisições excedido                 |
| `500`  | Internal Server Error | Erro interno do servidor                       |

```json theme={null}
{
    "success": false,
    "message": "Erro de validação",
    "data": {
        "errors": {
            "campo": ["mensagem de erro"]
        }
    }
}
```

***

## Precisa de ajuda?

Nosso time de suporte está sempre disponível para auxiliar você durante o processo de integração. Se tiver dúvidas, encontrar problemas ou precisar de orientação técnica, não hesite em nos contatar.

<CardGroup cols={2}>
  <Card title="WhatsApp de Suporte" icon="whatsapp" href="https://wa.me/+555181791451?text=Ola%2C%20estou%20integrando%20a%20Pluggou%20em%20meu%20sistema%20e%20estou%20com%20duvidas%2C%20poderia%20me%20auxiliar%3F">
    Fale diretamente com nosso time técnico pelo WhatsApp para tirar dúvidas em tempo real.
  </Card>

  <Card title="Dashboard Pluggou" icon="gauge" href="https://pluggoucash.com">
    Acesse o painel administrativo para gerenciar sua conta, visualizar transações e obter suas credenciais.
  </Card>
</CardGroup>