SDK
API software development kit
Use the official Asaas SDKs to integrate with the API using the language's own structures and services, without manually implementing all the HTTP communication.
The Asaas SDK was created to make integrating with our API easier, reducing the complexity of HTTP calls, response handling, and data serialization. It offers a simpler, safer, and more productive way to work with the platform's features.
SDK or REST API?
The SDK uses the Asaas REST API and does not change the endpoint rules.
Choose according to your application's needs:
| Scenario | Recommended path |
|---|---|
| There is an official SDK for the language used | Use the SDK |
| You prefer working with DTOs, models, and typed services | Use the SDK |
| There is no official SDK for your language | Integrate directly with the REST API |
| You need direct control over the HTTP layer | Integrate directly with the REST API |
You can also combine both models in the same application.
You can adopt the SDK gradually, using it only in parts of your application, as it makes sense for your project.
What the SDK abstracts
The SDK organizes communication with the API through:
- DTOs and models for requests and responses;
- services separated by domain, such as payments, customers, and subscriptions;
- authentication configuration;
- selection of the Sandbox or Production environment;
- serialization of requests and responses;
- handling of errors returned by the API.
The API's business rules, permissions, and limits still apply as usual.
Available SDK
Currently, the official Asaas SDK is available for Java and can also be used in Kotlin applications.
Java
The Java SDK is distributed through Maven Central and provides services and models for the supported API resources.
In the specific documentation, you will find:
- installation with Maven or Gradle;
- API Key configuration;
- selection between Sandbox and Production;
- timeout configuration;
- usage examples;
- integration with Spring Boot.
Next steps
Updated 2 days ago