¿Cómo funciona el paginado en las request a la API de Skipo?
Generalmente, las respuestas de la API vienen con muchos datos. Como una forma de no sobrecargar el servidor y evitar demoras en las respuestas se incluye la paginación que divide la respuesta en bloques más pequeños.
Requests
Las requests con paginado deben tener los siguientes query parameters:
Parámetro | Default | Descripción |
---|---|---|
take | 10 | Elementos a por página. (min: 1, max: 50) |
page | 1 | Número de página a recibir. |
Si es que no se definen estos parámetros en la request entonces tomarán los valores por defecto que figuran en la tabla.
Respuesta
Por su lado, cada respuesta de los endpoints con paginado vendrá con información relevante respecto a las páginas y los elementos que contiene, todo esto dentro de un objeto meta
.
La estructura del objeto meta
es la siguiente:
Atributo | Tipo | Descripción |
---|---|---|
currentSize | integer | La cantidad de elementos en la página solicitada actual |
currentPage | integer | El número de la página solicitada actual |
totalPages | integer | La cantidad total de páginas |
totalCount | integer | La cantidad total de elementos |
Obtener todos los datos
En ciertas ocasiones vas a querer obtener todos los datos de un endpoint con paginado. Para esto debes iterar por todas las páginas de la respuesta, empezando por la
1
y terminando entotalPages
Ejemplo de respuesta
{
data: [
{
type: 'WITHDRAWAL',
currency: 'CLP',
detail: 'Withdrawal with Redpay',
quantity: -5000,
fee: 0,
total: -5000,
balance: 2246560,
date: '2024-03-28T21:47:28.647Z'
},
...
],
meta: {
currentSize: 10,
currentPage: 1,
totalPages: 9,
totalCount: 87
}
}