ค้นหา Links

GEThttps://api.omise.co/links/search

ค้นหาลิงก์ชำระเงินโดยใช้เงื่อนไขต่างๆ เช่น title, amount, currency, status และ metadata ส่งคืนรายการลิงก์ที่ตรงกันแบบแบ่งหน้า

---

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

ค้นหา - 2 ฟิลด์พารามิเตอร์การค้นหา

▼

`query`STRING(optional)

ข้อความค้นหา ค้นหาในฟิลด์ title, description และ metadata

Example:"Invoice #12345"

`filters`OBJECT(optional)

ออบเจกต์เงื่อนไขตัวกรอง รองรับการกรองตาม amount, currency, used status, multiple flag และช่วงวันที่สร้าง

Example:{"amount":100000,"currency":"thb","used":false}

การแบ่งหน้า - 3 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

ค้นหาเสร็จสมบูรณ์ ส่งคืนรายการลิงก์ที่ตรงกันแบบแบ่งหน้า

โครงสร้าง Response:

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

400

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

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

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

• ค่าตัวกรองไม่ถูกต้อง
• รูปแบบวันที่ในตัวกรองไม่ถูกต้อง
• ค่า limit ไม่ถูกต้อง (เกินค่าสูงสุด)
• ข้อความค้นหาไม่ถูกต้อง

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/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "query=Invoice" \
  -d "filters[currency]=thb" \
  -d "filters[used]=false" \
  -d "limit=20"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = Omise::Link.search(
  query: 'Invoice',
  filters: { currency: 'thb', used: false },
  limit: 20
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = omise.Link.search(
    query='Invoice',
    filters={'currency': 'thb', 'used': False},
    limit=20
)

Node.js

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

const links = await omise.links.search({
  query: 'Invoice',
  filters: { currency: 'thb', used: false },
  limit: 20
});

PHP

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

$links = OmiseLink::search([
    'query' => 'Invoice',
    'filters' => ['currency' => 'thb', 'used' => false],
    'limit' => 20
]);

Java

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

SearchResult<Link> links = client.links().search()
    .query("Invoice")
    .filter("currency", "thb")
    .filter("used", false)
    .limit(20)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var links = await client.Links.Search(new SearchLinkRequest
{
    Query = "Invoice",
    Filters = new Dictionary<string, object>
    {
        { "currency", "thb" },
        { "used", false }
    },
    Limit = 20
});

Go

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

links, _ := client.Links().Search(&operations.SearchLink{
    Query: "Invoice",
    Filters: map[string]interface{}{
        "currency": "thb",
        "used":     false,
    },
    Limit: 20,
})

---

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

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบค่าและรูปแบบพารามิเตอร์
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_filter	ค่าตัวกรองไม่ถูกต้อง	ตรวจสอบให้แน่ใจว่าค่าตัวกรองตรงกับประเภทที่คาดหวัง

ตัวกรองที่ใช้ได้

ตัวกรอง	ประเภท	คำอธิบาย
amount	integer	กรองตามจำนวนเงินที่ตรงกัน
currency	string	กรองตามรหัสสกุลเงิน (thb, jpy, sgd, myr, usd)
used	boolean	กรองตามสถานะการใช้งาน
multiple	boolean	กรองตามความสามารถในการใช้ซ้ำ
created_at	object	กรองตามช่วงวันที่สร้าง (gte, lte)

---

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

▼

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

query(ไม่บังคับ)

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

▼

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