---
agentTools:
  projectIndex: https://docs.ninepay.com.br/llms.txt
  projectSearch: https://docs.ninepay.com.br/agentSearch?query=term1%20term2
---

# Postman

Importe a coleção da API no Postman, escolha o ambiente e faça a primeira requisição.

Use a coleção do Postman para testar os endpoints da API antes de implementar as chamadas na sua aplicação.

> 📘 Ao final deste guia
> Você terá a coleção e um ambiente importados no Postman, sua credencial configurada e uma requisição executada.

## Quando usar

- explorar os endpoints sem escrever código;
- conferir autenticação, headers e URLs;
- testar o corpo de uma requisição antes de levá-lo para a sua aplicação;
- reproduzir um erro durante o desenvolvimento;
- compartilhar requisições com o seu time.

## Antes de começar

- Instale o [Postman](https://www.postman.com/downloads/) ou use a versão web.
- Tenha uma credencial de acesso à API para o ambiente que vai testar.

> ⚠️ Proteja sua credencial
> Não publique sua credencial em workspaces públicos, capturas de tela, repositórios ou conversas. Use credenciais de teste sempre que a API oferecer um ambiente de testes.

## 1. Baixe os arquivos

Baixe a coleção e o ambiente do servidor que vai usar. A coleção é a mesma para todos os ambientes: só o ambiente muda.

- [NinePay API — coleção do Postman](https://docs.ninepay.com.br/postman/ninepay-api.postman_collection.json)
- [NinePay API — ambiente Servidor de Testes (sandbox)](https://docs.ninepay.com.br/postman/ninepay-api.servidor-de-testes-sandbox.postman_environment.json)

## 2. Importe no Postman

1. No Postman, abra o workspace em que quer guardar a coleção e clique em **Import**.
2. Arraste a coleção e o ambiente para a janela ou clique em **files** para selecioná-los. Também dá para colar o endereço de um arquivo (clique com o botão direito no botão de download e copie o link).
3. Confirme em **Import**. A coleção aparece em **Collections** e o ambiente, em **Environments**.

## 3. Selecione o ambiente

Cada ambiente define a variável `baseUrl` com a URL base de um servidor da API:

| Ambiente | URL base (`baseUrl`) |
| --- | --- |
| Servidor de Testes (sandbox) | `https://api.sandbox.cefispay.com.br/api/v1` |

No seletor de ambientes, no canto superior direito, escolha o ambiente importado. Sem um ambiente selecionado, as requisições usam o `baseUrl` da própria coleção (o primeiro servidor).

## 4. Informe sua credencial

A autenticação já está configurada na aba **Authorization** da coleção e as requisições a herdam. Ela usa as variáveis abaixo, que vêm vazias:

| Variável | Uso | Referência |
| --- | --- | --- |
| `token` | Token de acesso, enviado como `Authorization: Bearer <token>` | `{{token}}` |

Em **Environments**, abra o ambiente selecionado, preencha o valor da variável e salve (**Ctrl+S** ou **Cmd+S**). As variáveis de credencial são do tipo **secret**: o valor fica mascarado na tela.

## 5. Envie uma requisição

1. Abra uma pasta da coleção e selecione um endpoint.
2. Confira a URL e a aba **Params**: as variáveis de path (`:id`) e os parâmetros opcionais, que vêm desmarcados.
3. Ajuste o corpo de exemplo na aba **Body**, quando houver.
4. Clique em **Send** e confira o status e o corpo da resposta.

Uma resposta com status `2xx` indica sucesso. O código exato e o formato da resposta estão na página do endpoint, na Referência.

## Erros comuns

| Problema | O que verificar |
| --- | --- |
| `401` ou `403` | Se a variável de credencial está preenchida no ambiente selecionado e se a credencial é do mesmo ambiente da URL. |
| URL com `{{baseUrl}}` ou erro de URL inválida | Se há um ambiente selecionado no canto superior direito. |
| `404` | Se as variáveis de path da aba **Params** foram preenchidas. |
| `400` ou `422` | Se o corpo é um JSON válido e segue os campos descritos na página do endpoint. |

## Atualizações

Os arquivos são gerados novamente a cada publicação desta documentação, a partir da mesma especificação OpenAPI da Referência.

Para receber endpoints novos ou alterados, baixe a coleção de novo e importe-a. O Postman avisa que a coleção já existe e pergunta se deve substituí-la ou importar uma cópia.

## Próximos passos

- [Consulte a Referência da API](/reference/criar-novo-pagamento)
- [Use a coleção no Insomnia](/docs/insomnia)
- [Veja todas as collections](/docs/collections)