L’appel de toute méthode de liste qui renvoie plusieurs résultats, comme /customers, peut nécessiter une pagination : plusieurs appels pour récupérer tous les résultats. Metronome fournit deux paramètres d’URL sur tous les endpoints de liste à cette fin :
limit personnalise le nombre de résultats renvoyés par pagenext_page spécifie le curseur à utiliser comme point de départ pour récupérer le prochain ensemble de résultats
Lorsqu’une réponse renvoyée contient une valeur next_page, cela signifie qu’il existe plus d’enregistrements que ceux qui ont été renvoyés. Incluez cette valeur next_page dans une requête ultérieure pour récupérer le prochain ensemble de résultats. Pour récupérer tous les résultats, répétez ce processus jusqu’à ce que next_page soit null.
GET /v1/customers?limit=10
{
"data": [
{
"id": 1
},
{
"id": 2
},
// ...
]
// The next_page cursor that can be passed in the URL
// to get the next set of results.
"next_page": "0c34b75b47491b73db66d46737d9a87"
}
next_page à la requête suivante.
GET /v1/customers?limit=10&next_page=0c34b75b47491b73db66d46737d9a87
{
"data": [
{
"id": 3
}
],
// If no next_page value is returned, this is the last page of results.
"next_page": null
}
BONNES PRATIQUES POUR LIMITPour effectuer un appel d’API rapide afin d’inspecter le format de la réponse, définissez limit=1. Pour charger de nombreux résultats avec le moins d’appels d’API possible, définissez limit=50. Pour des raisons de performance, limit est plafonné à 100.
