Paginação

A paginacão da API Grafeno é gerenciada através de parâmetros simples e intuitivos, projetados para facilitar a navegação eficiente pelos conjuntos de dados retornados. Os parâmetros de paginação permitem aos usuários controlar quais dados são retornados e em que quantidade, otimizando assim o desempenho da aplicação e melhorando a experiência do usuário.

Parâmetros de Paginação Suportados

A API Grafeno suporta dois tipos principais de parâmetros de paginação:

p[page]: Este parâmetro especifica a página que deve ser carregada. Cada página representa uma parte do conjunto total de resultados. Por exemplo, p[page]=2 indica que a segunda página de resultados deve ser retornada.
p[per_page]: Este parâmetro determina o número de itens que devem ser carregados em cada página. Define a quantidade de resultados exibidos por página. Por exemplo, p[per_page]=10 significa que cada página deve conter até 10 itens.

Exemplo de Utilização
Para ilustrar como os parâmetros de paginação são utilizados em solicitações à nossa API, considere o seguinte exemplo: Suponha que desejamos recuperar a segunda página de resultados, onde cada página contém até 20 itens. Utilizamos a seguinte sintaxe:

curl --request GET \
     --url 'https://pagamentos.grafeno.be/api/v2/charges?p[per_page]=20&p[page]=2' \
     --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
     --header 'Account-Number: 081XXXXX-X'
     --header 'accept: application/json'

Neste caso, estamos instruindo a API a retornar a segunda página de resultados, cada uma contendo até 20 itens.

Benefícios da Paginação
A utilização de parâmetros de paginação em nossa API proporciona diversos benefícios, incluindo:

Eficiência: A paginação permite carregar conjuntos de dados grandes de forma incremental, reduzindo a carga no servidor e melhorando o desempenho da aplicação.
Controle: Os usuários têm controle total sobre a quantidade de dados retornados e a ordem em que são exibidos, proporcionando uma experiência de usuário personalizada.
Escalabilidade: A paginação facilita a manipulação de grandes volumes de dados, tornando nossa API escalável e preparada para lidar com um aumento na demanda.
Os parâmetros de paginação em nossa API oferecem uma maneira poderosa e flexível de controlar a exibição e a navegação pelos conjuntos de dados retornados. Ao adotar uma abordagem simples e intuitiva, proporcionamos uma experiência de usuário aprimorada, melhorando a eficiência e a escalabilidade de nossos serviços.