Antes de testarO console interativo da API Reference utiliza o Sandbox.
Para executar requisições nesta documentação, use uma chave de API criada no Sandbox. Uma chave de Produção não é válida nesse ambiente e resultará em
401 Unauthorized.Crie sua conta Sandbox e gere uma chave de API para testes.
A API Reference apresenta os endpoints disponíveis na API do Asaas, seus parâmetros, respostas e exemplos.
Você também pode executar requisições pelo console interativo e gerar exemplos de código em linguagens como PHP, Java e Ruby.
Começando uma integração?Se você ainda está definindo o fluxo da sua integração, acesse o Guia de Integrações.
Utilize a API Reference para consultar endpoints, parâmetros e respostas durante a implementação.
Ambientes da API
Utilize a URL base correspondente ao ambiente da sua chave de API.
| Ambiente | URL base |
|---|---|
| Sandbox | https://api-sandbox.asaas.com/v3 |
| Produção | https://api.asaas.com/v3 |
As contas, dados e chaves de API de Sandbox e Produção são independentes. Ao migrar sua integração, altere a URL base e utilize uma chave criada em Produção.
Como utilizar a API Reference
Em cada endpoint, você pode:
- consultar parâmetros de entrada e respostas disponíveis;
- informar sua chave de API e executar uma requisição no Sandbox;
- visualizar a resposta retornada pela API;
- gerar o exemplo da requisição em diferentes linguagens.
Para configurar corretamente o header access_token, consulte Autenticação.
Assista ao vídeo
Veja como utilizar a API Reference e executar requisições diretamente pela documentação.