สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
สรุปภาพรวมของช่องทางการเชื่อมต่อ (REST API และ Webhook) ที่พอร์ทัลนักพัฒนาของ ReceiptRoller มอบให้ พร้อมสิ่งที่ทำได้ด้วยแต่ละช่องทาง นี่คือหน้าแรกสำหรับผู้ที่กำลังจะเริ่มลงมือพัฒนา
สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
พอร์ทัลนักพัฒนาของ ReceiptRoller มอบช่องทางในการเชื่อมต่อข้อมูลรีเทลอย่างปลอดภัยจากระบบภายนอก ไม่ว่าจะเป็นข้อมูลการซื้อ ยอดขาย สินค้า สต็อก โฆษณา หรือใบเสร็จของผู้ใช้ ช่องทางการเชื่อมต่อมี 2 แบบ คือ REST API และ Webhook
ช่องทางการเชื่อมต่อ 2 แบบ
REST API (แบบ polling / แบบ request)
ส่งคำขอ HTTPS จากระบบภายนอกไปยังเซิร์ฟเวอร์ของ ReceiptRoller เพื่อดึงและจัดการข้อมูล ยืนยันตัวตนด้วย OAuth 2.0 แล้วเรียกเอนด์พอยต์โดยใช้แอ็กเซสโทเคนของสโคปที่จำเป็น
- จัดการสินค้า คำสั่งซื้อ สต็อก ลูกค้า คูปอง ฯลฯ ได้ภายในขอบเขตที่เจ้าของร้านอนุญาต
- พาร์ตเนอร์ที่ได้รับการอนุมัติสามารถเข้าถึงข้อมูลใบเสร็จและการใช้จ่ายที่ผู้ใช้ยินยอมได้
- เหมาะกับกรณีที่ต้องการ "ดึงสถานะปัจจุบันตอนนี้" หรือ "อัปเดตข้อมูล"
Webhook (แบบ push / แบบอีเวนต์)
อีเวนต์ที่เกิดขึ้นฝั่ง ReceiptRoller (เช่น การออกใบเสร็จ การอัปเดต) จะถูก POST ไปยัง URL ที่ลงทะเบียนไว้โดยอัตโนมัติ ระบบภายนอกไม่ต้อง poll API เป็นระยะ และสามารถเริ่มประมวลผลได้ทันทีที่อีเวนต์เกิดขึ้น
- รับการแจ้งเตือนมายังเซิร์ฟเวอร์ของคุณพร้อมกับการออกใบเสร็จ
- ตรวจสอบผู้ส่งได้ด้วยลายเซ็น (HMAC-SHA256)
- เมื่อส่งไม่สำเร็จ จะมีการลองส่งใหม่โดยอัตโนมัติสูงสุด 4 ครั้ง
สิ่งที่ทำได้ด้วย API
ทรัพยากรที่เข้าถึงได้จะถูกแบ่งตามสโคปของ OAuth ตัวอย่างที่พบบ่อยมีดังนี้ ดูรายการสโคปทั้งหมดได้ที่ รายการสโคป OAuth
| หมวดหมู่ | การดำเนินการหลัก | สโคปที่พบบ่อย |
|---|---|---|
| สินค้า / สต็อก | ดูและอัปเดตมาสเตอร์สินค้า SKU และจำนวนสต็อก | store.products.* store.inventory.read |
| คำสั่งซื้อ | ดูข้อมูลคำสั่งซื้อ อัปเดตสถานะ | store.orders.* |
| ลูกค้า / CRM | ดูข้อมูลลูกค้าและเซกเมนต์ | store.customers.read crm.profiles.read |
| คูปอง | สร้าง อัปเดต และดูคูปอง | store.coupons.* |
| ใบปลิวร้านค้า | สร้างและเผยแพร่ใบปลิว | store.flyers.* |
| SNS / การวิเคราะห์ | ดูโพสต์ SNS ผู้ชม และข้อมูลการวิเคราะห์ | sns.* analytics.read |
| ผู้ใช้ (ต้องผ่านการตรวจสอบ) | ใบเสร็จ การใช้จ่าย และร้านค้าโปรดของผู้ใช้แต่ละราย | user.* |
สิ่งที่ทำได้ด้วย Webhook
สมัครรับ (subscribe) อีเวนต์บน ReceiptRoller แล้วประมวลผลแบบเรียลไทม์ในระบบภายนอกได้
- อีเวนต์การออกใบเสร็จ — แจ้งไปยังเซิร์ฟเวอร์ของคุณทันทีที่ชำระเงินเสร็จที่ POS และมีการออกใบเสร็จอิเล็กทรอนิกส์
- อีเวนต์การอัปเดตใบเสร็จ — แจ้งเมื่อสถานะของใบเสร็จเปลี่ยนแปลง เช่น การคืนเงินหรือการยกเลิก
- อีเวนต์คำสั่งซื้อ — แจ้งเมื่อมีคำสั่งซื้อใหม่หรือการเปลี่ยนสถานะ (สำหรับร้านค้า)
สำหรับข้อควรระวังในการพัฒนา เช่น การตรวจสอบลายเซ็น การลองส่งใหม่ และการออกแบบให้รองรับ idempotency โปรดดู คู่มือ Webhook สำหรับร้านค้า