SDK
Kit de desenvolvimento de software da API
Use os SDKs oficiais do Asaas para integrar a API utilizando estruturas e serviços próprios da linguagem, sem implementar manualmente toda a comunicação HTTP.
O SDK do Asaas foi criado para facilitar a integração com a nossa API, reduzindo a complexidade de chamadas HTTP, tratamento de respostas e serialização de dados. Ele oferece uma maneira mais simples, segura e produtiva de trabalhar com os recursos da plataforma.
SDK ou API REST?
O SDK utiliza a API REST do Asaas e não altera as regras dos endpoints.
Escolha conforme a necessidade da aplicação:
| Cenário | Caminho recomendado |
|---|---|
| Existe um SDK oficial para a linguagem utilizada | Utilize o SDK |
| Você prefere trabalhar com DTOs, modelos e serviços tipados | Utilize o SDK |
| Não existe SDK oficial para sua linguagem | Integre diretamente com a API REST |
| Você precisa controlar diretamente a camada HTTP | Integre diretamente com a API REST |
Você também pode combinar os dois modelos na mesma aplicação.
Você pode adotar o SDK de forma gradual, utilizando-o apenas em partes da sua aplicação, conforme fizer sentido para o seu projeto.
O que o SDK abstrai
O SDK organiza a comunicação com a API por meio de:
- DTOs e modelos para requisições e respostas;
- serviços separados por domínio, como cobranças, clientes e assinaturas;
- configuração de autenticação;
- definição do ambiente de Sandbox ou Produção;
- serialização das requisições e respostas;
- tratamento dos erros retornados pela API.
As regras de negócio, permissões e limites da API continuam sendo aplicados normalmente.
SDK disponível
Atualmente, o SDK oficial do Asaas está disponível para Java e pode ser utilizado também em aplicações Kotlin.
Java
O SDK Java é distribuído pelo Maven Central e disponibiliza serviços e modelos para os recursos suportados da API.
Na documentação específica, você encontra:
- instalação com Maven ou Gradle;
- configuração da API Key;
- seleção entre Sandbox e Produção;
- configuração de timeout;
- exemplos de uso;
- integração com Spring Boot.
Próximos passos
Updated 1 day ago