รายการ Chain Keys

GEThttps://api.omise.co/chains/{id}/keys

รายการ API keys สำหรับการเชื่อมต่อ chain ส่งคืนรายการ keys แบบแบ่งหน้าที่เชื่อมโยงกับบัญชี sub-merchant ซึ่งสามารถใช้สำหรับการยืนยันตัวตนเมื่อดำเนินการในนามของพวกเขา

---

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

▼

---

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

จำเป็น - 1 ฟิลด์พารามิเตอร์ Path

▼

`id`STRING(required)

ตัวระบุ Chain ตรงกับรูปแบบ /acch(_test)?_[0-9a-z]+/ ระบุใน URL path

Example:"acch_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเป็น chain ID ที่ถูกต้อง

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

▼

---

การตอบกลับ

200

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

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

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

• object - ส่งคืน "list" เสมอ
• data - อาร์เรย์ของ key objects
• limit - ระเบียนต่อหน้า
• offset - จำนวนระเบียนที่ข้าม
• total - จำนวน keys ทั้งหมดที่ตรงกับตัวกรอง

400

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

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

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

• รูปแบบ chain ID ไม่ถูกต้อง
• รูปแบบวันที่ไม่ถูกต้องสำหรับพารามิเตอร์ from/to
• พารามิเตอร์การแบ่งหน้าไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ไม่พบ chain ด้วย ID ที่ระบุ

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

• รูปแบบ chain ID ไม่ถูกต้อง
• ไม่มี chain อยู่
• Chain เป็นของบัญชีอื่น
• ใช้ test key กับ live chain ID (หรือกลับกัน)

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/chains/acch_test_5xuy4w91xqz7d1w9u0t/keys \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = Omise::Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')
keys = chain.keys(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = omise.Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')
keys = chain.keys(limit=20, offset=0)

Node.js

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

const keys = await omise.chains.listKeys('acch_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$chain = OmiseChain::retrieve('acch_test_5xuy4w91xqz7d1w9u0t');
$keys = $chain->keys([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Key> keys = client.chains().listKeys("acch_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var keys = await client.Chains.ListKeys("acch_test_5xuy4w91xqz7d1w9u0t", new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

keys, _ := client.Chains().ListKeys("acch_test_5xuy4w91xqz7d1w9u0t", &omise.ListParams{
    Limit:  20,
    Offset: 0,
})

---

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

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

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

ฟิลด์ Key Object

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "key" เสมอ
id	string	ตัวระบุ key ที่ไม่ซ้ำกัน
livemode	boolean	ตัวบ่งชี้สภาพแวดล้อม production vs test
secret	boolean	เป็น secret key หรือไม่
created_at	string	เวลาสร้าง key (ISO 8601)

---

ลองใช้งาน

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

▼

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