feat: rate limit management

jpdev01 · Apr 7, 2024 · 5c8fd44 · 5c8fd44
1 parent 297a87a
commit 5c8fd44
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/docs/extra.md b/docs/extra.md
@@ -13,6 +13,9 @@ Asaas.setTimeout(10000);
 
 ## Rate Limit
 
+Possuímos limites de solicitações em certos endpoints onde o abuso pode de certa forma comprometer o desempenho e o uso das APIs do Asaas. Medimos as requisições e podemos restringi-las quando a quantidade permitida é ultrapassada.
+
+Você pode verificar o status nos cabeçalhos de resposta após uma requisição:
 ```java
 Transfer transfer = Transfer.pixAddressKeyCreator()
         .setPixAddressKey("PIX_KEY")

diff --git a/docs/ratelimit.md b/docs/ratelimit.md
@@ -0,0 +1,15 @@
+## Rate Limit
+
+Possuímos limites de solicitações em certos endpoints onde o abuso pode de certa forma comprometer o desempenho e o uso das APIs do Asaas. Medimos as requisições e podemos restringi-las quando a quantidade permitida é ultrapassada.
+
+Você pode verificar o status nos cabeçalhos de resposta após uma requisição:
+```java
+Transfer transfer = Transfer.pixAddressKeyCreator()
+        .setPixAddressKey("PIX_KEY")
+        .setValue(Money.create(0.01))
+        .setDescription("teste")
+        .setPixAddressKeyType(PixAddressKeyType.CPF)
+        .create();
+
+transfer.getRateLimit(); // Here you can get the rate limit of the last request
+```
diff --git a/docs/readme.md b/docs/readme.md
@@ -42,4 +42,5 @@ The API official documentation can be found [here](https://docs.asaas.com/docs/v
 ## Extra
 
 - [Configurações extras](extra.md)
-- [Exemples](https://github.com/jpdev01/asaasSdk/blob/master/src/main/java/io/github/jpdev/asaassdk/doc/Examples.java)
+- [Exemples](https://github.com/jpdev01/asaasSdk/blob/master/src/main/java/io/github/jpdev/asaassdk/doc/Examples.java)
+- [Rate Limit](ratelimit.md)