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

# Insomnia

Importe a API no Insomnia com ambientes e autenticação prontos e faça a primeira requisição.

Importe a API no Insomnia para ter todos os endpoints em uma coleção, organizados em pastas e com ambientes e autenticação prontos.

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

## Antes de começar

- Instale o [Insomnia](https://insomnia.rest/download).
- 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 o arquivo

Um único arquivo traz a coleção e todos os ambientes.

- [NinePay API — arquivo do Insomnia](https://docs.ninepay.com.br/insomnia/ninepay-api.insomnia.json)

## 2. Importe no Insomnia

1. No Insomnia, abra o projeto em que quer guardar a coleção e clique em **Import**.
2. Escolha **File** e selecione o arquivo baixado, ou escolha **URL** e cole o endereço do arquivo (abaixo).
3. Clique em **Scan**, confira o resumo e confirme em **Import**. Uma coleção com o nome da API é criada, com uma pasta por grupo da Referência.

Endereço para a importação por URL:

```text
https://docs.ninepay.com.br/insomnia/ninepay-api.insomnia.json
```

> 📘 Alternativa: coleção do Postman
> O Insomnia também importa a [coleção do Postman](/docs/postman) (formato v2.1). Use-a se o seu time já trabalha com ela.

## 3. Escolha o ambiente

A coleção traz um ambiente base e um subambiente por servidor da API, cada um com a variável `baseUrl`:

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

No seletor de ambientes, acima da lista de requisições, escolha o subambiente. Sem um subambiente, vale o ambiente base (o primeiro servidor).

## 4. Informe sua credencial

Cada requisição já tem a autenticação configurada na aba **Auth**, usando as variáveis abaixo, que vêm vazias:

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

Abra **Manage Environments** (no seletor de ambientes), selecione o subambiente em uso e preencha o valor da variável. As alterações são salvas automaticamente.

## 5. Envie uma requisição

1. Abra uma pasta da coleção e selecione um endpoint.
2. Confira a URL e as abas **Params** (variáveis de path e parâmetros opcionais, que vêm desativados) e **Headers**.
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 |
| --- | --- |
| A importação não encontra requisições | Se o arquivo escolhido é o `.insomnia.json` desta página (ou a URL completa dele) e se ele foi baixado por inteiro. |
| `401` ou `403` | Se a variável de credencial está preenchida no subambiente selecionado e se a credencial é do mesmo ambiente da URL. |
| URL com `_.baseUrl` sem valor | Se há um subambiente selecionado ou se o ambiente base tem o `baseUrl` preenchido. |
| `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, importe o arquivo de novo. Se quiser comparar com a versão anterior antes de substituir, importe em um projeto separado.

## Próximos passos

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