ページネーション
リストとして返されるすべてのリソースはページネートされリソースの作成日の降順でソートされます。
ページあたりのアイテムの件数はデフォルトで10件です。
ページネートされたリストの形式
items
(array):リソースのリストhas_more
(boolean):表示されているリストの最後のリソースの次に更にリソースがあるかどうか
{
"items": [],
"has_more": false
}
次ページのリソースの取得
以下のパラメータを指定することでリストの次のページを取得することが可能です。
limit
(number):10–100の範囲の整数で返却するリソースの数cursor
(string):リソースの取得開始位置を指定する為のリソースのID
このリソースの次のリソースから取得され、このIDで指定したリソースはレスポンスには含まないcursor_direction
:リソースのソート順で、asc
(昇順) もしくはdesc
(降順)
例えば、以下のリクエストで最初の100個の課金(Charge)リソースを取得することができます。
curl -h 'Authorization: Bearer {secret}.{jwt}' https://api.univapay.com/charges?limit=100
{
"items": [
{
"id": "4050058b-646a-4fae-8876-babf0dc0c3f0"
...
},
...
{
"id": "34daac6d-63a8-485b-a9ea-75a2e24a258d"
...
}
],
"has_more": true
}
"has_more":true
となっているのでさらにリソースがある事がわかります。
次の100件の課金を取得するには、リストの最後のリソースID34daac6d-63a8-485b-a9ea-75a2e24a258d
をリクエストパラメータのcursor
として指定します。
curl -h 'Authorization: Bearer {secret}.{jwt}' https://api.univapay.com/charges?cursor=34daac6d-63a8-485b-a9ea-75a2e24a258d&limit=100