DiscordStatus
Guias / Guides

Insomnia

Import the Asaas OpenAPI specification into Insomnia to generate a Collection, configure requests, and fix common import issues.

Import the Asaas API into Insomnia

Import the Asaas OpenAPI specification to create a Collection with the API endpoints in your workspace.

📘

By the end of this guide, you will have imported the Asaas API endpoints and prepared a Collection to run tests in Insomnia.

Before you start

You need to:

  1. Install or open Insomnia.
  2. Create or access a workspace.
  3. Have an API key to test the requests. See Authentication.
  4. Choose the specification language: Brazilian Portuguese or English.
⚠️

The import creates the requests, but it does not configure your API key or run calls automatically.

1. Create a Collection

In your workspace, create an empty Collection named Collection Asaas.

2. Start the import

Click the Collection name and select Import.

3. Provide the OpenAPI specification

On the import screen, select URL and enter the address for the desired language.

Brazilian Portuguese

https://www.asaas.com/openApi/document?version=3&languageCode=pt-BR

English

https://www.asaas.com/openApi/document?version=3&languageCode=en-US

Click Scan and confirm the import.

4. Organize the endpoints

To keep the endpoints in the same order as the documentation:

  1. Find the Filter field.
  2. Click the sort icon.
  3. Select Oldest First.

5. Configure the requests

Before sending a request:

  • configure the environment URL;
  • provide your API key;
  • review the headers;
  • fill in the required parameters;
  • check the request body, when applicable.

See Authentication to configure environments and headers correctly.

⚠️

Sandbox and Production API keys are different. Use a key that matches the environment configured in the request.

How to confirm the import

After the import, the Collection should show the endpoints available in the OpenAPI specification.

The import does not validate:

  • your credentials;
  • parameter values;
  • the data sent in the body;
  • the API key's permissions.

This information must be configured before the first test.

Common errors

SituationHow to fix it
The import doesn't find any endpointsCheck that the URL contains version=3 and the correct languageCode. Then click Scan again.
The Collection was imported in another languageRepeat the import using the URL for the desired language.
An endpoint doesn't appear in InsomniaImport the specification again to update the Collection.
The request returns an authentication errorCheck the API key, the environment, and the headers. See Authentication.
Duplicate requests after an updateCreate a new Collection to compare the versions or remove the duplicate requests.

Update your Collection

Re-import the OpenAPI specification when you need to access new endpoints or changes published in the documentation.

Before updating the existing Collection, consider creating a new version to avoid duplicate requests or changes to local settings.

Next steps


Updated 7 days ago

Did this page help you?