Insomnia
Importe a especificação OpenAPI do Asaas no Insomnia para gerar uma Collection, configurar requisições e resolver problemas comuns de importação.
Importe a especificação OpenAPI do Asaas no Insomnia para criar uma Collection com os endpoints da API e testar requisições no seu workspace.
O Insomnia é uma ferramenta para testar APIs. Use este fluxo quando você quiser carregar os endpoints da documentação do Asaas automaticamente, validar chamadas durante o desenvolvimento ou comparar sua Collection local com a versão atual da documentação.
Pré-requisitos
- Instale ou abra o Insomnia.
- Crie ou acesse um workspace onde a Collection do Asaas será salva.
- Tenha acesso à chave de API antes de executar requisições importadas. Para configurar os headers corretamente, consulte Autenticação.
- Escolha o idioma da especificação OpenAPI (arquivo que descreve endpoints, parâmetros e respostas da API): inglês ou português do Brasil.
O que esperar após a importação
A importação cria uma Collection com os endpoints disponíveis na especificação OpenAPI informada. Ela não executa chamadas automaticamente e não valida suas credenciais durante o processo de importação.
Antes de enviar requisições, revise os headers, variáveis de ambiente e parâmetros obrigatórios no Insomnia. Se você importar a especificação novamente para atualizar endpoints, confira se deseja atualizar a Collection existente ou criar uma nova para evitar duplicidade de requests.
Importar a Collection no Insomnia
- No seu workspace no Insomnia, crie uma nova Collection vazia e dê o nome de
Collection Asaas.
- Com a Collection criada, no topo da página, clique no nome da Collection e selecione Import.
- Na tela de importação, selecione Url e informe a URL do arquivo OpenAPI da documentação.
Para importar a Collection em inglês, use:
https://www.asaas.com/openApi/document?version=3&languageCode=en-USPara importar a Collection em português do Brasil, use:
https://www.asaas.com/openApi/document?version=3&languageCode=pt-BR- Clique em Scan e confirme a importação.
- Ajuste a ordenação dos endpoints importados para manter a mesma sequência da documentação: ao lado do campo Filter, clique no ícone de ordenação e selecione Oldest First.
Solução de problemas
| Situação | Como resolver |
|---|---|
| A importação não encontra endpoints | Confirme se a URL foi copiada por completo, incluindo version=3 e languageCode. Depois, clique em Scan novamente. |
| A Collection foi importada em outro idioma | Repita a importação usando a URL correspondente ao idioma desejado. |
| Um endpoint da documentação não aparece no Insomnia | Importe novamente a especificação OpenAPI para atualizar a Collection local. |
| A requisição retorna erro de autenticação | Configure a chave de API e os headers antes de executar a chamada. Consulte Autenticação. |
| A Collection ficou com requests duplicados após uma nova importação | Revise a Collection importada e remova os requests duplicados, ou crie uma nova Collection para comparar com a anterior antes de substituir seu fluxo de testes. |
Próximos passos
- Configure a autenticação das requisições em Autenticação.
- Se você usa Postman em vez de Insomnia, consulte Postman.
- Reimporte a especificação quando precisar sincronizar sua Collection com endpoints novos ou atualizados na documentação.