Chaque fois que vous envoyez une requête pour obtenir une liste de ressources de l'API, le nombre de ressources renvoyées est limité à 50*.
Pour obtenir des résultats qui contiennent plus de ressources que la limite, l'API renvoie un paramètre after qui peut être utilisé pour envoyer une autre requête pour générer la liste de résultats suivante.
Par exemple, si vous envoyez une requête pour obtenir la liste de tous vos paiements mais que le nombre de paiement dépasse la limite.
{
"payments": [
{
"id": "PM0001",
"created_at": "2017-06-14T04:32:45.482Z",
"charge_date": "2017-06-19",
"amount": 1000,
"description": "test",
"currency": "GBP",
"status": "paid_out",
"amount_refunded": 0,
"reference": null,
"metadata": {},
"links": {
"mandate": "MD00012345678",
"creditor": "CR00012345678",
"payout": "PO00012345678",
"subscription": "SB00012345678"
},
-------(49 PAIEMENTS SUIVANTS)-------
],
"meta": {
"cursors": {
"before": null,
"after": "PM00050"
},
"limit": 50
}
}
Le paramètre after vous permet ensuite de récupérer l'ensemble de résultats suivant en envoyant une nouvelle requête à l'API. Par exemple, https://api.gocardless.com/payments?after=PM00050
Cela génèrera un autre résultat JSON avec un paramètre after. Si le paramètre after est une valeur nulle, vous avez alors atteint la fin des résultats et vous pouvez arrêter d'envoyer de nouvelles requêtes.
*La valeur par défaut du nombre de résultats renvoyé est 50, mais il est possible de la changer à 500 en définissant le paramètre limit dans votre requête.