Pagination

Chaque endpoint de liste renvoie un tableau items et un objet meta. Deux modes partagent le même endpoint : la pagination par offset par défaut, la pagination par curseur dès que vous envoyez un cursor. La forme de meta vous indique lequel vous avez obtenu.

Paramètres

Les filtres dépendent de la ressource, ils ne sont pas globaux. Sur GET /payments :

Pagination par offset

Le mode par défaut. Demandez un numéro de page, vous recevez un meta qui indique combien il y en a au total :

curl "https://api.wajub.com/payments?per_page=2&status=succeeded" \
-H "Authorization: $WAJUB_API_KEY"

Bouclez jusqu'à ce que current_page atteigne last_page. Utilisez la plus grande taille de page possible, 100, pour qu'un historique de 137 lignes tienne en deux requêtes au lieu de six :

async function allPayments(filters = {}) {
const all = [];
let page = 1;

while (true) {
  const params = new URLSearchParams({ ...filters, per_page: '100', page: String(page) });
  const res = await fetch(`https://api.wajub.com/payments?${params}`, {
    headers: { Authorization: process.env.WAJUB_API_KEY },
  });
  const { items, meta } = await res.json();

  all.push(...items);

  if (page >= meta.last_page) break;
  page += 1;
}

return all;
}

Pagination par curseur

La pagination par offset recompte toute la table à chaque page, et les lignes insérées pendant votre parcours décalent la fenêtre. Les curseurs règlent ces deux problèmes : passez cursor et chaque page est ancrée sur la dernière ligne que vous avez vue.

meta change de forme dans ce mode. current_page, last_page et total disparaissent, remplacés par :

Renvoyez next_cursor comme cursor et arrêtez-vous quand has_more vaut false :

async function* streamPayments() {
let cursor = null;

do {
  const params = new URLSearchParams({ per_page: '100' });

  if (cursor) params.set('cursor', cursor);

  const res = await fetch(`https://api.wajub.com/payments?${params}`, {
    headers: { Authorization: process.env.WAJUB_API_KEY },
  });
  const { items, meta } = await res.json();

  yield* items;
  cursor = meta.has_more ? meta.next_cursor : null;
} while (cursor);
}

Endpoints et modes pris en charge

Le mode curseur est disponible partout où la liste a un tri stable sur created_at. Trois listes ne proposent que l'offset.