Before testingThe API Reference interactive console uses the Sandbox.
To run requests in this documentation, use an API key created in the Sandbox. A Production key is not valid in this environment and will result in
401 Unauthorized.Create your Sandbox account and generate an API key for testing.
The API Reference presents the endpoints available in the Asaas API, along with their parameters, responses and examples.
You can also run requests through the interactive console and generate code samples in languages such as PHP, Java and Ruby.
Starting an integration?If you are still defining your integration flow, check out the Integration Guide.
Use the API Reference to look up endpoints, parameters and responses during implementation.
API environments
Use the base URL that matches the environment of your API key.
| Environment | Base URL |
|---|---|
| Sandbox | https://api-sandbox.asaas.com/v3 |
| Production | https://api.asaas.com/v3 |
Sandbox and Production accounts, data and API keys are independent. When migrating your integration, change the base URL and use a key created in Production.
How to use the API Reference
On each endpoint, you can:
- check the available input parameters and responses;
- enter your API key and run a request in the Sandbox;
- view the response returned by the API;
- generate the request sample in different languages.
To correctly configure the access_token header, see Authentication.
Watch the video
See how to use the API Reference and run requests directly from the documentation.