แสดงรายการลิงก์ทั้งหมด

GEThttps://api.omise.co/links

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

---

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

▼

---

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

Additional - 5 fieldsAdditional Parameters

▼

---

การตอบกลับ

200

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

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

โครงสร้างการตอบกลับ:

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

400

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

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดเพื่อดูรายละเอียด

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

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

401

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

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

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

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

---

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

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

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

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

การแบ่งหน้า

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

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

---

ลองใช้งาน

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

▼