Autenticação
Dúvidas frequentes sobre autenticação na API do Asaas
Por que não encontro a aba de integração no meu navegador?
O motivo de não encontrar a aba de integrações no seu navegador (web), muito provavelmente seja porque seu usuário não é do tipo administrador. O menu de Integrações está apenas para usuários administradores.
Como posso recuperar a minha chave de API?
A chave de API é irrecuperável, caso seja perdida, é necessário a geração de uma nova.
Estou recebendo erro 401 ao tentar testar na documentação.
A nossa documentação aceita apenas chamadas de sandbox. Caso esteja recebendo erro de autenticação, é possível estar utilizando uma chave de produção e com isso está ocasionando o erro.
Por que quando gero a chave ela desaparece ao atualizar a página?
É uma questão de segurança. Como se trata de uma informação extremamente sensível da sua conta, não podemos deixá-la exposta. Então, só será apresentada no momento que você gerar, após isso caso você atualize a página, por exemplo, irá aparecer apenas o botão para Gerar nova chave de API novamente e se você gerar uma nova irá invalidar a anterior.
Aonde faço a geração da minha chave de API?
Você pode gerar a sua chave de API diretamente pela interface Web do ASAAS, indo em Integrações > Chave de API > Gerar nova chave de API.
Como se trata de uma informação bem sigilosa da conta, não conseguimos gerar ela aqui para você, somente realizando o processo acima. Após a geração da chave de API em nossa interface, armazene-a diretamente em seu cofre de chaves, evitando que seja exposta em mensagens de qualquer tipo ou emails. Nunca deixe a chave de API diretamente no código fonte de seus sistemas.
É importante destacar que ela só será apresentada no momento que você gerar, após isso caso você atualize a página, por exemplo, irá aparecer apenas o botão para Gerar nova chave de API novamente e se você gerar uma nova irá invalidar a anterior.
Outro ponto é que não é possível gerar a chave pelo APP. Apenas pela web.
Posso criar mais de uma chave API para a minha conta?
Não. A chave de API é única por conta. Caso você gere uma nova chave, a anterior será invalidada.
Recebendo erro 401, o que posso fazer?
O erro 401 indica que a autenticação da chamada na API não foi validada com sucesso, e geralmente acusa o uso de uma chave de API inválida. Nessas situações, podemos utilizar os seguintes questionamentos:
- Está enviando a API Key na requisição? Conforme explicado aqui.
- O header está escrito corretamente "access_token"?
- Está usando a chave de API correspondente ao ambiente em uso? (Sandbox/Produção)
- Verificou se o endpoint requisitado está correto? (Sandbox/Produção)
- Já fez um teste executando a geração de uma nova chave de API gerada?
Como posso definir meu user-agent?
O cabeçalho de requisição User-Agent é utilizado para identificar a aplicação cliente que está realizando a chamada para a API. Ele é uma cadeia de caracteres que pode conter informações como nome da aplicação, versão, linguagem ou framework utilizado, além de detalhes adicionais que ajudem a rastrear ou diferenciar integrações.
Sintaxe sugerida:
User-Agent: <nome-aplicacao>/<versao> (<informacoes-adicionais>)
Exemplos:
User-Agent: MinhaLoja/1.0.3 (Node.js; produção)
User-Agent: ERPInterno/2.1 (Java_17; staging)
Observações:
- A maioria dos frameworks ou SDKs já define um valor padrão para o User-Agent (por exemplo, Java/1.8.0, python-requests/2.31.0, etc).
- Recomendamos substituir ou complementar o valor padrão com informações que identifiquem melhor sua aplicação.
- Caso você mantenha o valor padrão do framework, ainda assim será possível processar as requisições, mas a visibilidade sobre a origem ficará reduzida. Personalizar ajuda no suporte e no rastreamento.
Updated 9 days ago