แสดงรายการ Links ทั้งหมด

GEThttps://api.omise.co/links

ส่งคืนคอลเลกชันลิงก์ชำระเงินทั้งหมดในบัญชีของคุณแบบแบ่งหน้า กรองตามช่วงวันที่และควบคุมลำดับการเรียง

---

พารามิเตอร์คำขอ

เพิ่มเติม - 5 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ดึงรายการลิงก์สำเร็จ ส่งคืนรายการแบบแบ่งหน้าพร้อม metadata

โครงสร้าง Response:

• object - ส่งคืน "list" เสมอ
• data - อาร์เรย์ของออบเจกต์ลิงก์
• limit - จำนวนรายการต่อหน้า
• offset - จำนวนรายการที่ถูกข้าม
• total - จำนวนลิงก์ทั้งหมดที่ตรงกับตัวกรอง
• order - ลำดับการเรียงที่ใช้
• from - ตัวกรองวันที่เริ่มต้นที่ใช้
• to - ตัวกรองวันที่สิ้นสุดที่ใช้

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความ error สำหรับรายละเอียด

สาเหตุทั่วไป:

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• ค่า limit ไม่ถูกต้อง (เกินค่าสูงสุด)
• ค่า order ไม่ถูกต้อง
• พารามิเตอร์ไม่ถูกต้อง

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือขาดหายไป

สาเหตุทั่วไป:

• ขาด Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

5xx

เซิร์ฟเวอร์ error

เกิด error ฝั่งเซิร์ฟเวอร์ กรณีนี้พบได้น้อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการ Error สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/links \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0" \
  -d "order=reverse_chronological"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = Omise::Link.list(
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = omise.Link.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const links = await omise.links.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$links = OmiseLink::retrieve([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Link> links = client.links().list()
    .limit(20)
    .offset(0)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var links = await client.Links.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0,
    Order = ListOrder.ReverseChronological
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

links, _ := client.Links().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
    Order:  omise.ReverseChronological,
})

---

รหัส Error และผลลัพธ์

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบค่าและรูปแบบพารามิเตอร์
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_date_format	การตรวจสอบรูปแบบวันที่ล้มเหลว	ใช้รูปแบบ ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)

การแบ่งหน้า

เพื่อแบ่งหน้าผลลัพธ์:

• ใช้ limit เพื่อควบคุมขนาดหน้า (สูงสุด 100)
• ใช้ offset เพื่อข้ามรายการ
• ตรวจสอบ total ใน response เพื่อทราบจำนวนรายการที่มีทั้งหมด
• ตัวอย่าง: หน้า 2 ที่ 20 รายการต่อหน้า = offset=20&limit=20

---

🔑ข้อมูลยืนยันตัวตน API

▼

ลองใช้งาน

เพิ่มเติม - 5 ฟิลด์

▼

IP ของคุณ: ...กำลังโหลด...