การแบ่งหน้า
นำทางชุดผลลัพธ์ขนาดใหญ่อย่างมีประสิทธิภาพด้วยการแบ ่งหน้า API ของ Omise เรียนรู้วิธีใช้พารามิเตอร์ limit และ offset เพื่อดึงข้อมูลเป็นกลุ่มที่จัดการได้
ภาพรวม
endpoint ของ Omise API จำนวนมากส่งคืนรายการของทรัพยากร (การเรียกเก็บเงิน ลูกค้า การโอนเงิน ฯลฯ) เพื่อให้การตอบกลับรวดเร็วและจัดการได้ง่าย endpoint เหล่านี้จะส่งคืนผลลัพธ์แบบแบ่งหน้า คุณสามารถควบคุมจำนวนรายการที่จะดึงข้อมูลต่อคำขอและหน้าที่จะเรียกข้อมูล
เริ่มต้นอย่างรวดเร็ว
- ใช้
limitเพื่อควบคุมจำนวนรายการต่อหน้า (ค่าเริ่มต้น: 20, สูงสุด: 100) - ใช้
offsetเพื่อข้ามรายการและนำทางหน้า - ตรวจสอบ
totalเพื่อทราบจำนวนรายการที่มีอยู่ - การตอบกลับแบบรายการทั้งหมดมีโครงสร้างเดียวกัน
พารามิเตอร์การแบ่งหน้า
limit
ประเภท: Integer ค่าเริ่มต้น: 20 ช่วง: 1-100 วัตถุประสงค์: จำนวนรายการที่จะส่งคืนต่อคำขอ
# รับ 50 การเรียกเก็บเงินต่อคำขอ
curl https://api.omise.co/charges?limit=50 \
-u skey_test_5xuy4w91xqz7d1w9u0t:
offset
ประเภท: Integer ค่าเริ่มต้น: 0 วัตถุประสงค์: จำนวนรายการที่จะข้ามก่อนเริ่มส่งคืนผลลัพธ์
# ข้าม 20 การเรียกเก็บเงินแรก ส่งคืน 20 รายการถัดไป
curl https://api.omise.co/charges?offset=20&limit=20 \
-u skey_test_5xuy4w91xqz7d1w9u0t:
ตัวอย่างรวม
# รับรายการ 41-60 (หน้า 3 พร้อม 20 รายการต่อหน้า)
curl https://api.omise.co/charges?offset=40&limit=20 \
-u skey_test_5xuy4w91xqz7d1w9u0t:
รูปแบบการตอบกลับรายการ
endpoint ที่มีการแบ่งหน้าทั้งหมดส่งคืนโครงสร้างรายการที่สอดคล้องกัน:
{
"object": "list",
"data": [
{
"object": "charge",
"id": "chrg_test_5xuy4w91xqz7d1w9u0t",
"amount": 100000,
...
},
{
"object": "charge",
"id": "chrg_test_5xuy4w91xqz7d1w9u0a",
"amount": 50000,
...
}
],
"limit": 20,
"offset": 0,
"total": 142,
"from": "2025-01-01T00:00:00Z",
"to": "2025-02-07T23:59:59Z",
"order": "chronological",
"location": "/charges"
}
ฟิลด์ออบเจ็กต์รายการ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
object | string | เป็น "list" เสมอสำหรับการตอบกลับแบบแบ่งหน้า |
data | array | อาร์เรย์ของออบเจ็กต์ทรัพยากร (ก ารเรียกเก็บเงิน ลูกค้า ฯลฯ) |
limit | integer | จำนวนรายการต่อหน้า (จากคำขอ) |
offset | integer | จำนวนรายการที่ข้าม (จากคำขอ) |
total | integer | จำนวนรายการทั้งหมดในทุกหน้า |
from | string (ISO 8601) | วันที่เริ่มต้นของช่วงเวลาคิวรี (ตัวเลือก) |
to | string (ISO 8601) | วันที่สิ้นสุดของช่วงเวลาคิวรี (ตัวเลือก) |
order | string | ลำดับการเรียง: "chronological" หรือ "reverse_chronological" |
location | string | เส้นทาง endpoint ของ API |
endpoint ที่มีการแบ่งหน้า
endpoint ต่อไปนี้รองรับการแบ่งหน้า:
ทรัพยากรหลัก
| Endpoint | ลำดับเริ่มต้น | คำอธิบาย |
|---|---|---|
GET /charges | ย้อนเวลาตามลำดับ | รายการการเรียกเก็บเงินทั้งหมด |
GET /customers | ย้อนเวลาตามลำดับ | รายการลูกค้าทั้งหมด |
GET /transfers | ย้อนเวลาตามลำดับ | รายการการโอนเงินทั้งหมด |
GET /refunds | ย้อนเวลาตามลำดับ | รายการการคืนเงินทั้งหมด |
GET /transactions | ย้อนเวลาตามลำดับ | รายการธุรกรรมทั้งหมด |
GET /disputes | ย้อนเวลาตามลำดับ | รายการข้อพิพาททั้งหมด |
GET /recipients | ย้อนเวลาตามลำดับ | รายการผู้รับทั้งหมด |
GET /events | ย้อนเวลาตามลำดับ | รายการเหตุการณ์ทั้งหมด |
GET /schedules | ย้อนเวลาตามลำดับ | รายการกำหนดการทั้งหมด |
GET /links | ย้อนเวลาตามลำดับ | รายการลิงก์การชำระเงินทั้งหมด |