Bruno

O Bruno é um cliente HTTP de código aberto que guarda as collections em arquivos de texto, dentro de uma pasta do seu projeto — o que permite versioná-las no Git junto com o código. Ele importa collections do Postman no formato v2.1 nativamente, então o arquivo é o mesmo que o do Postman.

⬇️ 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 Bruno.

A descrição de cada requisição vira a aba Docs dela no Bruno, 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 Bruno, clique no botão +, no canto superior esquerdo da barra lateral, e escolha Import Collection.
2. Arraste o arquivo nextcode-apis.postman_collection.json para a janela, ou clique para procurá-lo. O Bruno reconhece sozinho que é uma collection do Postman.
3. Escolha a pasta do seu computador onde a collection será gravada e confirme em Import.

O Bruno converte a collection e cria a pasta Nextcode APIs, com as cinco subpastas e um arquivo .bru por requisição.

A collection vira arquivos de texto

Depois da importação, cada requisição é um arquivo .bru legível na pasta que você escolheu. Se ela ficar dentro de um repositório, as requisições passam a ser versionadas junto com o código.

Como configurar as variáveis

As três variáveis da collection chegam como variáveis de coleção e já aparecem preenchidas com os valores padrão.

1. Clique nos três pontos ao lado da collection Nextcode APIs e escolha Settings.
2. Abra a aba Vars.
3. Ajuste os valores — o que cada variável significa está em Como configurar as variáveis.

🚧 Não versione a sua chave de API

As variáveis de coleção são gravadas em collection.bru, um arquivo de texto que entra no Git. Mantenha a apiKey fora dele: crie um Environment (menu de ambientes, no canto superior direito) com um apiKey secreto, ou use um arquivo .env na raiz da collection e leia o valor com {{process.env.NEXTCODE_API_KEY}}. Os dois ficam fora do commit.

Autenticação

A autenticação vem configurada no nível da collection, como API Key no header:

Authorization: ApiKey {{apiKey}}

Você confere em Settings → Auth. As requisições ficam com Inherit e herdam essa configuração — nenhuma delas precisa de header de autenticação próprio.

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 Select Files e escolha 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 Insomnia.