แสดงรายการ Webhook Secrets

GEThttps://api.omise.co/webhooks/secrets

แสดงรายการ webhook signing secrets ทั้งหมดสำหรับบัญชีของคุณ ใช้ endpoint นี้เพื่อดู secrets ที่มีอยู่ ตรวจสอบวันที่สร้าง และจัดการการหมุนเวียนคีย์ โปรดทราบว่าค่า secret จริงจะไม่ถูกส่งคืน จะแสดงเพียงครั้งเดียวตอนสร้าง

---

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

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

▼

`limit`INTEGER(optional)

จำนวน secrets ที่จะส่งคืนต่อหน้า

Example:20

Constraints:ค่าต่ำสุด: 1, ค่าสูงสุด: 100, ค่าเริ่มต้น: 20

Default:20

`offset`INTEGER(optional)

จำนวน secrets ที่จะข้ามสำหรับการแบ่งหน้า ใช้กับ limit เพื่อแบ่งหน้าชุดผลลัพธ์ขนาดใหญ่

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงของผลลัพธ์

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

---

การตอบกลับ

200

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

ส่งคืนรายการอ็อบเจกต์ webhook secret แบบแบ่งหน้า โปรดทราบว่าค่า secret จริงจะไม่รวมอยู่ในการตอบกลับเพื่อเหตุผลด้านความปลอดภัย

รวมถึง:

• object - ประเภทอ็อบเจกต์ (เป็น "list" เสมอ)
• data - อาร์เรย์ของอ็อบเจกต์ webhook secret
• limit - จำนวนผลลัพธ์ต่อหน้า
• offset - จำนวนผลลัพธ์ที่ข้าม
• total - จำนวน secrets ทั้งหมด
• order - ลำดับการเรียงที่ใช้

400

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

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

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

• limit เกินค่าสูงสุด (100)
• พารามิเตอร์ order ไม่ถูกต้อง
• ค่า offset เป็นค่าลบ

401

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

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

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/webhooks/secrets \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = Omise::WebhookSecret.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = omise.WebhookSecret.list(
    limit=20,
    offset=0
)

Node.js

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

const secrets = await omise.webhookSecrets.list({
  limit: 20,
  offset: 0
});

PHP

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

$secrets = OmiseWebhookSecret::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<WebhookSecret> secrets = client.webhookSecrets().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var secrets = await client.WebhookSecrets.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

secrets, _ := client.ListWebhookSecrets(&operations.ListWebhookSecrets{
    Limit:  20,
    Offset: 0,
})

---

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

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

รหัส	คำอธิบาย	การแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบค่าพารามิเตอร์
invalid_parameters	พารามิเตอร์การแบ่งหน้าไม่ถูกต้อง	ตรวจสอบค่า limit และ offset

ฟิลด์รายการ Webhook Secret

ฟิลด์	คำอธิบาย
object	ประเภทอ็อบเจกต์ (เป็น "list" เสมอ)
data	อาร์เรย์ของอ็อบเจกต์ webhook secret
limit	จำนวนรายการต่อหน้า
offset	จำนวนรายการที่ข้าม
total	จำนวน secrets ทั้งหมด
order	ลำดับการเรียงที่ใช้

ฟิลด์อ็อบเจกต์ Webhook Secret

ฟิลด์	คำอธิบาย
object	ประเภทอ็อบเจกต์ (เป็น "webhook_secret" เสมอ)
id	ตัวระบุ secret เฉพาะ (whsec_*)
livemode	เป็น secret โหมดจริงหรือไม่
created_at	timestamp การสร้างในรูปแบบ ISO 8601

---

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

▼

ลองใช้งาน

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