Fonctionnement de la pagination

L’API Stripe comporte des endpoints de liste et de recherche qui peuvent renvoyer plusieurs objets, tels que la liste des clients ou la recherche de PaymentIntents. Pour atténuer les impacts négatifs sur les performances, ces endpoints ne renvoient pas tous les résultats en même temps. Stripe renvoie une page de résultats par appel à l’API, chaque page contenant jusqu’à 10 résultats par défaut. Utilisez le paramètre limite pour modifier le nombre de résultats par page.

Par exemple, il s’agit d’une requête d’API pour répertorier les clients, avec une valeur limit de 3 :

curl -G https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d limit=3

La réponse de Stripe contient une page avec 3 résultats :

{
  "data": [
    {
      "id": "cus_005",
      "object": "customer",
      "name": "John Doe",
    },
    {
      "id": "cus_004",
      "object": "customer",
      "name": "Jane Doe",
    },
    {
      "id": "cus_003",
      "object": "customer",
      "name": "Jenny Rosen",
    },
  ],
  "has_more": true,
  /* ... */
}

Gardez à l’esprit les détails suivants lorsque vous utilisez ces endpoints :

• Les objets se trouvent dans la propriété data.
• Les objets sont dans l’ordre chronologique inverse, ce qui signifie que l’objet le plus récent apparaît en premier.
• La propriété has_more indique si d’autres objets n’ont pas été renvoyés dans cette requête.

Au lieu de parcourir le tableau pour passer en revue les objets data, vous pouvez paginer les résultats. Cela vous permet d’éviter d’omettre certains objets lorsque le paramètre has_more est défini sur true.

Autopagination

Pour récupérer tous les objets, utilisez la fonction de pagination automatique. Celle-ci effectue automatiquement plusieurs appels à l’API jusqu’à ce que le paramètre has_more devienne false.

customers = Stripe::Customer.list()

customers.auto_paging_each do |customer|
    # Do something with customer
end

Pagination manuelle

Suivez ces étapes pour paginer manuellement les résultats. Ce processus est différent selon que vous appelez un endpoint de liste ou un endpoint de recherche.

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

curl -G https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d starting_after={{LAST_CUSTOMER_ID}}