So funktioniert die Paginierung

Die Stripe-API verfügt über Listen- und Such-Endpoints, die mehrere Objekte zurückgeben können, z. B. die Auflistung von Kundinnen/Kunden oder die Suche nach PaymentIntents. Um negative Auswirkungen auf die Leistung zu minimieren, geben diese Endpoints nicht alle Ergebnisse auf einmal zurück. Stattdessen gibt Stripe eine Seite mit Ergebnissen pro API-Aufruf zurück, wobei jede Seite standardmäßig bis zu 10 Ergebnisse enthält. Verwenden Sie den limit-Parameter, um die Anzahl der Ergebnisse pro Seite zu ändern.

Dies ist beispielsweise eine API-Anfrage zum Auflisten von Kundinnen/Kunden mit einem limit-Wert von 3:

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

Die Antwort von Stripe enthält eine Seite mit 3 Ergebnissen:

{
  "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,
  /* ... */
}

Beachten Sie bei der Verwendung dieser Endpoints Folgendes:

• Objekte befinden sich innerhalb der data-Eigenschaft.
• Die Objekte befinden sich in umgekehrter chronologischer Reihenfolge, d. h. das zuletzt erstellte Objekt ist das erste.
• Die Eigenschaft has_more gibt an, ob es zusätzliche Objekte gibt, die in dieser Anforderung nicht zurückgegeben wurden.

Anstatt das data-Array in einer Schleife zu durchlaufen, um die Objekte zu durchsuchen, sollten Sie die Ergebnisse paginieren. Dadurch wird verhindert, dass Sie einige Objekte übersehen, wenn der has_more-Parameter true ist.

Automatische Paginierung

Um alle Objekte abzurufen, verwenden Sie die Funktion für die automatische Paginierung. Dadurch werden automatisch mehrere API-Aufrufe getätigt, bis has_more false wird.

customers = Stripe::Customer.list()

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

Manuelle Paginierung

Befolgen Sie diese Schritte, um die Ergebnisse manuell zu paginieren. Dieser Prozess ist unterschiedlich, je nachdem, ob Sie einen Listen-Endpoint oder einen Such-Endpoint aufrufen.

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}}