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 API do Asaas no Insomnia
Importe a especificação OpenAPI do Asaas para criar uma Collection com os endpoints da API no seu workspace.
Ao concluir este guia, você terá importado os endpoints da API do Asaas e preparado uma Collection para realizar testes no Insomnia.
Antes de começar
Você precisa:
- Instalar ou abrir o Insomnia.
- Criar ou acessar um workspace.
- Ter uma chave de API para testar as requisições. Consulte Autenticação.
- Escolher o idioma da especificação: português do Brasil ou inglês.
A importação cria as requisições, mas não configura sua chave de API nem executa chamadas automaticamente.
1. Crie uma Collection
No seu workspace, crie uma Collection vazia com o nome Collection Asaas.
2. Inicie a importação
Clique no nome da Collection e selecione Import.
3. Informe a especificação OpenAPI
Na tela de importação, selecione URL e informe o endereço correspondente ao idioma desejado.
Português do Brasil
https://www.asaas.com/openApi/document?version=3&languageCode=pt-BRInglês
https://www.asaas.com/openApi/document?version=3&languageCode=en-USClique em Scan e confirme a importação.
4. Organize os endpoints
Para manter os endpoints na mesma sequência da documentação:
- Localize o campo Filter.
- Clique no ícone de ordenação.
- Selecione Oldest First.
5. Configure as requisições
Antes de enviar uma requisição:
- configure a URL do ambiente;
- informe sua chave de API;
- revise os headers;
- preencha os parâmetros obrigatórios;
- confira o body da requisição, quando aplicável.
Consulte Autenticação para configurar os ambientes e headers corretamente.
As chaves de API de Sandbox e Produção são diferentes. Use uma chave correspondente ao ambiente configurado na requisição.
Como confirmar a importação
Após a importação, a Collection deve apresentar os endpoints disponíveis na especificação OpenAPI.
A importação não valida:
- suas credenciais;
- os valores dos parâmetros;
- os dados enviados no body;
- as permissões da chave de API.
Essas informações devem ser configuradas antes do primeiro teste.
Erros comuns
| Situação | Como resolver |
|---|---|
| A importação não encontra endpoints | Confira se a URL contém version=3 e o languageCode correto. Depois, clique em Scan novamente. |
| A Collection foi importada em outro idioma | Repita a importação usando a URL do idioma desejado. |
| Um endpoint não aparece no Insomnia | Importe novamente a especificação para atualizar a Collection. |
| A requisição retorna erro de autenticação | Confira a chave de API, o ambiente e os headers. Consulte Autenticação. |
| Requests duplicados após uma atualização | Crie uma nova Collection para comparar as versões ou remova os requests duplicados. |
Atualize sua Collection
Reimporte a especificação OpenAPI quando precisar acessar endpoints novos ou alterações publicadas na documentação.
Antes de atualizar a Collection existente, avalie criar uma nova versão para evitar requests duplicados ou alterações nas configurações locais.
Próximos passos
- Configure a autenticação
- Conheça o ambiente Sandbox
- Use a coleção do Postman
- Consulte a referência da API
Updated 12 days ago