ดึง event

GEThttps://api.omise.co/events/:id

ดึงข้อมูลรายละเอียดเกี่ยวกับ event เฉพาะ ใช้ endpoint นี้เพื่อตรวจสอบรายละเอียด event ดีบักการส่ง webhook และตรวจสอบข้อมูลที่ส่งไปยัง webhooks ของคุณ

---

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

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

▼

`id`STRING(required)

Event ID ที่จะดึง Event IDs เริ่มต้นด้วย evnt_ ตามด้วย test_ สำหรับโหมดทดสอบ

Example:"evnt_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ส่งคืนอ็อบเจกต์ event พร้อมรายละเอียดที่สมบูรณ์รวมถึงข้อมูลที่ทำให้เกิด event และข้อมูลการส่ง webhook

อ็อบเจกต์ Event ประกอบด้วย:

• object - ค่าสตริง "event"
• id - ตัวระบุ Event (evnt_*)
• livemode - บูลีนระบุโหมด live หรือ test
• location - พาธ API เพื่อดึง event
• key - ประเภท Event (เช่น charge.complete)
• data - อ็อบเจกต์ที่สมบูรณ์ที่ทำให้เกิด event
• actor_uid - User ID ของผู้ที่ทำให้เกิด event
• user_uid - User ID ที่เกี่ยวข้องกับ event
• team_uid - Sub-merchant ID (Payfac เท่านั้น)
• webhook_deliveries - อาร์เรย์ของบันทึกการส่ง webhook สำหรับ event
• created_at - เวลาที่ event เกิดขึ้น (ISO 8601)

401

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

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

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

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

404

ไม่พบ

ไม่พบ Event หรือไม่มีอยู่

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

• Event ID ไม่ถูกต้อง
• Event ID จากบัญชีอื่น
• ใช้ keys โหมด test และ live ผสมกัน
• Event ถูกสร้างเมื่อมากกว่า 90 วันที่แล้ว (events เก็บไว้ 90 วัน)

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/events/evnt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = Omise::Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = omise.Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const event = await omise.events.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$event = OmiseEvent::retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

Java

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

Event event = client.events().get("evnt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var event = await client.Events.Get("evnt_test_5xuy4w91xqz7d1w9u0t");

Go

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

event, _ := client.GetEvent("evnt_test_5xuy4w91xqz7d1w9u0t")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบ Event	ตรวจสอบ event ID และให้แน่ใจว่าใช้โหมดที่ถูกต้อง (test/live)

รหัสสถานะการส่ง Webhook

สถานะ	คำอธิบาย
200	ส่งและประมวลผลสำเร็จ
4xx	ข้อผิดพลาดไคลเอนต์ (คำขอไม่ถูกต้อง, การยืนยันตัวตนล้มเหลว)
5xx	ข้อผิดพลาดเซิร์ฟเวอร์ (endpoint ของคุณมีข้อผิดพลาด)
null	การส่งล้มเหลว (timeout, การเชื่อมต่อถูกปฏิเสธ)

---

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

▼

ทดลองใช้งาน

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

▼

id(จำเป็น)

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