Comenzar

Paginación

Paginación

Los endpoints de listado retornan resultados paginados. Controlas la paginación con parámetros de consulta y lees los metadatos desde los headers de respuesta.

Parámetros de Consulta

ParámetroPor defectoDescripción
page1Número de página
items20Elementos por página

Headers de Respuesta

Los metadatos de paginación siguen el estándar RFC 8288:

HeaderDescripción
LinkEnlaces de navegación (first, prev, next, last)
Current-PageNúmero de página actual
Page-ItemsElementos en esta página
Total-PagesNúmero total de páginas
Total-CountNúmero total de registros

Ejemplo

$curl "https://app.recurrente.com/api/products?page=2&items=10" \
>  -H "X-PUBLIC-KEY: ..." \
>  -H "X-SECRET-KEY: ..."

Headers de respuesta:

Link: <.../products?page=1&items=10>; rel="first", <.../products?page=1&items=10>; rel="prev", <.../products?page=3&items=10>; rel="next", <.../products?page=5&items=10>; rel="last"
Current-Page: 2
Page-Items: 10
Total-Pages: 5
Total-Count: 47

Uso Común

Para iterar a través de todos los elementos:

  1. Comienza con page=1
  2. Procesa los resultados
  3. Si Current-Page < Total-Pages, incrementa la página y repite
  4. Continúa hasta que hayas procesado todas las páginas