# Integração com a API

#### Introdução

A integração com a API foi projetada para ser simples e eficiente. Os endpoints seguem o padrão RESTful, e os dados são enviados e recebidos no formato **JSON**.

#### URL Base

A API oferece dois ambientes distintos: **Produção** e **Sandbox** (para testes). Certifique-se de utilizar a URL apropriada para o seu caso.

| Ambiente | URL Base                           | Descrição                                            |
| -------- | ---------------------------------- | ---------------------------------------------------- |
| Produção | `https://api.pagou.com.br`         | Ambiente real, utilizado para operações em produção. |
| Sandbox  | `https://sandbox-api.pagou.com.br` | Ambiente de testes, sem impacto em dados reais.      |

#### Headers Necessários

Todas as requisições à API exigem os seguintes cabeçalhos:

| Cabeçalho      | Obrigatório | Descrição                                                                                                    |
| -------------- | ----------- | ------------------------------------------------------------------------------------------------------------ |
| `X-API-KEY`    | Sim         | Sua chave de autenticação. Disponível em [Configurações da API](https://app.pagou.com.br/configuracoes/api). |
| `Content-Type` | Sim         | Indica o formato do corpo da requisição. Use sempre `application/json`.                                      |
| `User-Agent`   | Sim         | Identifica o cliente ou aplicação que está fazendo a requisição.                                             |

**Dica de segurança**: Nunca exponha sua chave de API em código público (ex.: GitHub). Armazene-a em variáveis de ambiente ou arquivos de configuração seguros.

### Testando no Sandbox

O ambiente de sandbox permite simular pagamentos sem custos reais:

* Envie requisições para `https://sandbox-api.pagou.com.br`.
* Teste cenários como pagamento aprovado, recusado ou pendente.

**Dica**: Use ferramentas como Postman para testar requisições interativamente.

#### Explicação dos Headers Necessários

1. **`X-API-KEY`**: Este cabeçalho é fundamental para autenticação, assegurando que apenas usuários autorizados possam acessar a API. Sua chave pessoal pode ser encontrada nas configurações da API.
2. **`Content-Type`**: Este cabeçalho especifica o formato dos dados enviados no corpo da requisição. Para garantir que a API entenda corretamente as requisições, utilize sempre o valor `application/json`.
3. **`User-Agent`**: Este cabeçalho indica qual cliente ou aplicação está realizando a requisição. Isso pode ajudar no registro de logs e na análise de uso dos serviços da API.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pagou.com.br/integracao-com-a-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.