Pular para o conteúdo principal

Como Paginar pela a API de Transações?

Paginação pela API de Transações

Nós disponibilizamos o endpoint /api/v1/transaction para que você possa visualizar transactions de sua empresa.

Você pode acessar aqui a documentação referente a esse endpoint.

O endpoint limita a 100 transações por request, porém é possível visualizar outras transações paginando a API.

Após efetuar a primeira requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, junto da lista de transações você receberá um objeto nomeado de pageInfo.

Num exemplo, essa será a nossa resposta:

{
"pageInfo": {
"skip": 0,
"limit": 100,
"totalCount": 200,
"hasPreviousPage": false,
"hasNextPage": true
},
"transactions": [
...transactions,
]
}

É possível enviar o parametro skip na query string da requisição, para visualizar a próxima página, podemos retornar o valor do skip sendo pageInfo.skip + pageInfo.limit.

Nesse exemplo, essa seria a url da próxima requisição:

/api/v1/transaction?skip=100

Também é possível fácilmente saber se existe uma nova página a ser requisitada, isso pode ser verificado usando o campo hasNextPage enviado dentro do objeto de pageInfo.