วิธีลงทะเบียน Webhook

Webhook การลงทะเบียน endpoint การสมัครรับอีเวนต์
บทความนี้เหมาะสำหรับใคร
เหมาะสำหรับนักพัฒนาแอปที่ใช้ Webhook ของ ReceiptRoller บทความนี้อธิบายขั้นตอนตั้งแต่การลงทะเบียน Webhook endpoint จากพอร์ทัลนักพัฒนา ไปจนถึงการยืนยันการเชื่อมต่อด้วยการส่งทดสอบ

ในการรับ Webhook คุณต้องลงทะเบียน「Webhook endpoint」ให้กับแอปในพอร์ทัลนักพัฒนา endpoint คือ URL ปลายทางที่ ReceiptRoller จะส่ง POST ไปเมื่อเกิดอีเวนต์ คุณสามารถลงทะเบียนหลาย endpoint ให้กับแอปเดียวได้ จึงสามารถแยกใช้งานตามวัตถุประสงค์หรือสภาพแวดล้อมได้

เงื่อนไขเบื้องต้น

  • ได้ลงทะเบียนแอปในพอร์ทัลนักพัฒนาแล้ว (สร้างแอปใหม่)
  • มีเซิร์ฟเวอร์สำหรับรับและ URL แบบ HTTPS พร้อมแล้ว
  • สามารถเก็บ secret สำหรับตรวจสอบลายเซ็นฝั่งผู้รับได้อย่างปลอดภัย

ขั้นตอนการลงทะเบียน

ขั้นตอนที่ 1:เปิดแท็บ「Webhook」ของแอป

พอร์ทัลนักพัฒนา → รายการแอป → เปิดแอปเป้าหมาย → คลิก「Webhook」ที่แท็บด้านบน

ขั้นตอนที่ 2:คลิก「เพิ่ม endpoint」

เมื่อกดปุ่ม「+ เพิ่ม endpoint」ที่มุมขวาบน ฟอร์มลงทะเบียนจะเปิดขึ้น

ขั้นตอนที่ 3:กรอกรายการที่จำเป็น

รายการ จำเป็น เนื้อหา
ชื่อ endpoint จำเป็น ป้ายชื่อสำหรับการจัดการ เช่น「production - ซิงค์สินค้าคงคลัง」
URL จำเป็น ต้องเป็น https:// ไม่อนุญาต query หรือ fragment
อีเวนต์ที่สมัครรับ จำเป็น เลือกอีเวนต์ที่ต้องการรับ (เลือกได้หลายรายการ)
ร้านค้าเป้าหมาย เลือกได้ ระบุเมื่อต้องการจำกัดเฉพาะบางร้าน เว้นว่าง=ทุกร้าน
คำอธิบาย เลือกได้ บันทึกการดำเนินงาน วัตถุประสงค์ที่แชร์กันในทีม
เปิด/ปิดใช้งาน จำเป็น แนะนำให้「เปิดใช้งาน」เมื่อลงทะเบียน เมื่อต้องการหยุดชั่วคราวให้สลับเป็น「ปิดใช้งาน」

ขั้นตอนที่ 4:คลิก「สร้าง」

เมื่อการลงทะเบียนเสร็จสิ้น ระบบจะพาไปยังหน้ารายละเอียดของ endpoint ที่นี่ secret สำหรับตรวจสอบลายเซ็น (Webhook Secret) จะแสดงเพียงครั้งแรกครั้งเดียว โปรดเก็บไว้ในที่ปลอดภัย ณ จุดนี้เสมอ

สำคัญ:Webhook Secret จะไม่แสดงอีกเลยเมื่อออกจากหน้านี้ หากไม่ได้เก็บไว้ จะต้องสร้างใหม่ และในจุดนั้นการตรวจสอบที่ใช้ secret เดิมจะล้มเหลว

วิธีเลือกอีเวนต์ที่สมัครรับ

เราแนะนำอย่างยิ่งให้จำกัดอีเวนต์ที่สมัครรับไว้เฉพาะที่จำเป็นเท่านั้น ด้วยเหตุผลดังนี้

  • ลดภาระของเซิร์ฟเวอร์ฝั่งผู้รับ
  • ตรรกะการประมวลผลเรียบง่ายขึ้น (ไม่มีการแยกสาขาสำหรับอีเวนต์ที่ไม่ต้องการ)
  • ลดสัญญาณรบกวนขณะติดตามระบบ

เช่น หากวัตถุประสงค์คือ「ซิงค์สินค้าคงคลัง」ให้สมัครรับเฉพาะ inv…

วันที่เผยแพร่: 2569-04-27 วันที่อัปเดต: 2569-07-06
แท็ก
API (22) OAuth (15) Android (10) iOS (9) Webhook (8) api (7) oauth (5) getting-started (4) การลงทะเบียนแอป (4) การแก้ปัญหา (4)
บทความที่เกี่ยวข้อง