Insomnia

O Insomnia é um cliente HTTP para testar APIs. Ele importa collections do Postman no formato v2.1 nativamente, então o arquivo é o mesmo que o do Postman — não existe uma versão à parte para o Insomnia.

⬇️ Download

nextcode-apis.postman_collection.json

São 24 requisições, organizadas nas mesmas pastas do menu desta documentação. A collection é a mesma para os três clientes — a lista das pastas está em O que vem na collection e os documentos usados nas requisições, em Dados de exemplo. Esta página cobre só o que muda no Insomnia.

A descrição de cada requisição vira a aba Docs dela no Insomnia, com o link para a página de referência correspondente e os avisos sobre as rotas que se comportam de forma inesperada.

Como importar

1. No Insomnia, abra o Dashboard e clique em Import, no canto superior direito.
2. Escolha File, ou arraste o arquivo nextcode-apis.postman_collection.json para a janela.
3. Confirme em Scan e depois em Import.

O Insomnia reconhece o arquivo como uma collection do Postman e cria uma coleção chamada Nextcode APIs, com as cinco pastas.

Como configurar as variáveis

As variáveis da collection chegam no Insomnia como o ambiente base da coleção.

1. Abra a coleção Nextcode APIs.
2. Clique no seletor de ambiente, no topo da barra lateral, e escolha Manage Environments (ou pressione Ctrl/Cmd + E).
3. Preencha os valores no Base Environment:

{
  "baseUrl": "https://api-homolog.nxcd.app",
  "apiKey": "SUA_CHAVE_AQUI",
  "livenessRequestId": ""
}

O que cada variável significa está em Como configurar as variáveis.

Separe homologação de produção

Em vez de trocar a baseUrl toda vez, crie dois sub-ambientes — um para cada URL, cada um com a sua chave — e alterne entre eles pelo seletor de ambiente.

Confira a autenticação depois de importar

Na collection, a autenticação está configurada no nível da coleção, como API Key no header:

Authorization: ApiKey {{apiKey}}

Dependendo da versão do Insomnia, essa configuração pode não vir junto na importação. Confira antes da primeira chamada:

1. Clique com o botão direito na coleção Nextcode APIs e escolha Settings.
2. Abra a aba Auth.
3. Se estiver em None, troque para API Key e preencha:
   • Key: Authorization
   • Value: ApiKey {{apiKey}}
   • Add to: Header
4. Nas requisições, deixe a autenticação como Inherit from parent.

Um 401 na primeira chamada é o sintoma de que essa configuração não veio junto.

Endpoints com upload de arquivo

Os campos de arquivo já existem no corpo da requisição, mas vazios: o arquivo sai do seu computador e precisa ser escolhido por você.

1. Abra a requisição e vá até a aba Body, em Multipart Form.
2. Na linha do campo (file, ou frente e verso, ou documento e selfie), clique em Choose File e selecione a imagem ou o PDF.
3. Envie.

O nome do campo, os limites de formato e tamanho e os dois endpoints que exigem dois arquivos estão em Endpoints com upload de arquivo.

Outras ferramentas

O mesmo arquivo é importado pelo Postman e pelo Bruno.