Bruno

Bruno is an open-source HTTP client that keeps collections in text files, inside a folder of your project — which lets you version them in Git along with the code. It imports Postman collections in the v2.1 format natively, so the file is the same one used for Postman.

⬇️ Download

nextcode-apis.postman_collection.json

There are 24 requests, organized in the same folders as the menu of this documentation, with folder and request names in Portuguese, exactly as they appear in the file. The collection is the same one for all three clients — the folder list is in What comes in the collection, and the documents used in the requests are in Sample data. This page covers only what changes in Bruno.

The description of each request becomes its Docs tab in Bruno, with the link to the corresponding reference page and the warnings about the routes that behave unexpectedly.

How to import

1. In Bruno, click the + button, at the top left of the sidebar, and choose Import Collection.
2. Drag the nextcode-apis.postman_collection.json file into the window, or click to browse for it. Bruno recognizes on its own that it is a Postman collection.
3. Choose the folder on your computer where the collection will be written and confirm with Import.

Bruno converts the collection and creates the Nextcode APIs folder, with the five subfolders and one .bru file per request.

The collection becomes text files

After the import, each request is a readable .bru file in the folder you chose. If that folder sits inside a repository, the requests end up versioned along with the code.

How to set the variables

The three variables of the collection arrive as collection variables and already show up filled in with the default values.

1. Click the three dots next to the Nextcode APIs collection and choose Settings.
2. Open the Vars tab.
3. Adjust the values — what each variable means is described in How to set the variables.

🚧 Do not commit your API key

The collection variables are written to collection.bru, a text file that goes into Git. Keep apiKey out of it: create an Environment (environment menu, at the top right) with a secret apiKey, or use a .env file at the root of the collection and read the value with {{process.env.NEXTCODE_API_KEY}}. Either one stays out of the commit.

Authentication

Authentication comes configured at the collection level, as an API Key in the header:

Authorization: ApiKey {{apiKey}}

You can check it under Settings → Auth. The requests are left on Inherit and take on that configuration — none of them needs an authentication header of its own.

Endpoints with file upload

The file fields already exist in the body of the request, but empty: the file comes from your computer and has to be picked by you.

1. Open the request and go to the Body tab, under Multipart Form.
2. On the row of the field (file, or frente and verso, or documento and selfie), click Select Files and choose the image or the PDF.
3. Send it.

The name of the field, the limits on format and size and the two endpoints that require two files are covered in Endpoints with file upload.

Other tools

The same file is imported by Postman and by Insomnia.