Skip to main content

Introdução

O Procfy utiliza o padrão de paginação para retornar os resultados das requisições. A paginação é utilizada para dividir os resultados em páginas, facilitando a visualização e a navegação entre os resultados. A paginação é utilizada em todas as rotas que retornam uma lista de resultados. Por exemplo, a rota de visualizar várias transações retorna uma lista de transações, e utiliza a paginação para dividir os resultados em páginas. A paginação é controlada através dos parâmetros page e itens. O parâmetro page indica o número da página, e o parâmetro itens indica a quantidade de itens por página.

Valores aceitos para os parâmetros

página

O parâmetro page deve ser um número inteiro maior que zero. O valor padrão é 1.

itens

O parâmetro items deve ser um número inteiro maior que zero. O valor padrão é 25.
O valor máximo para o parâmetro items é 50. Caso o valor informado seja maior que 50, será utilizado 50 como valor padrão.

Exemplo

Vamos fazer uma requisição para a API para listar todas as transações. Para isso, vamos utilizar o endpoint GET api/v1/transactions. A primeira requisição pode ser feita sem a inclusão de parâmetros, o que a API interpretará como a solicitação da primeira página. Caso deseje acessar uma página específica, basta fornecer o número da página no parâmetro page. Observe que os objetos que estão dentro da paginação são retornados no atributo data. Se os objetos forem de outro tipo, como contas bancárias, os nomes dos objetos presentes na página também serão incluídos no atributo data. Veja mais sobre isso na seção Acessando objetos de uma página. Exemplo de requisição para listar todas as transações (1ª página)
Exemplo de resposta para listar todas as transações (1ª página)
Exemplo de requisição para listar todas as transações (2ª página)

Acessando objetos de uma página

Ao realizar requisições para listar objetos paginados, como transações ou contatos, a API retorna uma estrutura consistente para facilitar a manipulação e a navegação pelos dados. Vamos explorar dois exemplos: transações e contatos.

Exemplo

Ao requisitar a listagem de todas as transações, a resposta é um objeto contendo o atributo data, o qual encapsula uma lista de transações disponíveis. A estrutura adotada facilita a identificação e manipulação desses dados específicos. De maneira análoga, ao requisitar a listagem de contatos, a resposta apresenta o atributo data contendo a lista correspondente. A estrutura é a mesma, independentemente do tipo de objeto solicitado.

Exemplo Prático

Considerando a requisição para listar transações, ao acessar response.data, você terá acesso direto à lista de transações retornadas. Essa abordagem proporciona clareza e praticidade ao trabalhar com objetos paginados em ambientes de programação.
Exemplo de resposta de uma requisição para listar todas as transações (1ª página)
Exemplo de resposta de uma requisição para listar todos os contatos (1ª página)
Exemplo de como acessar objetos de uma página

Erros

Parâmetros menores ou iguais a zero

Se a requisição enviar o parâmetro page com um valor menor ou igual a zero, ou enviar o parametro items com um valor menor ou igual a zero, a API retornará os erros ao lado.

Parâmetros maiores que o número de páginas

Caso o parâmetro page seja maior que o número de páginas, a API retornará o erro ao lado.
Enviando itens com valor menor ou igual a zero
Enviando page com valor menor ou igual a zero
Enviando page com valor 99, sendo que o número de páginas é 2