SLA อัตราการทำงาน และขั้นตอนตรวจสอบเมื่อเกิดเหตุขัดข้อง
อธิบายเป้าหมายอัตราการทำงานของ ReceiptRoller API วิธีตรวจสอบหน้าสถานะ ขั้นตอนการแยกแยะสาเหตุเมื่อเกิดเหตุขัดข้อง และขั้นตอนการยกระดับสู่ฝ่ายสนับสนุน
วิธีใช้ Transactions API (ฟิลด์รวม POS + OMS)
Transactions API ของ ReceiptRoller เป็น API อ่านอย่างเดียวที่รวมยอดขายจากแคชเชียร์ (PosTransactions) และคำสั่งซื้อจากระบบจัดการการขาย (OmsOrders) ไว้ในฟีดเดียว เป็นจุดเริ่มต้นเมื่อต้องการแสดงรายการ "ธุรกรรมทั้งหมดของบัญชีธุรกิจ" ในแอป Android／iOS
ProductDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ ProductDto ซึ่งเป็นมาสเตอร์สินค้า（PIM）ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การซิงก์แคตตาล็อกสินค้าจาก POS（Square）ต้นทุน・ราคารายร้าน・ตัวเลือกย่อย・สินค้าพรีออเดอร์
ขั้นตอนจนถึงเริ่มใช้งาน
อธิบายขั้นตอนจนถึงเริ่มใช้พอร์ทัลนักพัฒนาของ ReceiptRoller หากลงทะเบียนเป็นผู้ใช้ร้านค้าและเป็นแพลน Starter ขึ้นไป ก็สามารถเริ่มลงทะเบียนแอปและพัฒนา API ได้ทันทีโดยไม่ต้องยื่นคำขอเป็นนักพัฒนาต่างหาก
ขอโทเคนไม่ได้ (ข้อผิดพลาดการยืนยันตัวตน)
การแยกแยะสาเหตุเมื่อขอ access token ไม่ได้ อธิบายข้อผิดพลาดทั่วไป เช่น invalid_client, invalid_grant, redirect_uri_mismatch และวิธีรับมือ
ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
วิธีใช้ Reservations API
คู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
CrmCustomerDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ CrmCustomerDto ซึ่งเป็นมาสเตอร์ลูกค้าของ ReceiptRoller ข้อมูลลูกค้าที่ดึงมาจาก POS（スマレジ・Square）จะถูกทำให้เป็นรูปแบบมาตรฐานตามโมเดลนี้
พอร์ทัลนักพัฒนาไม่แสดงเมื่อยังใช้แพลนฟรี
ขั้นตอนการตรวจสอบเมื่อพอร์ทัลนักพัฒนาของ ReceiptRoller ไม่แสดง อธิบายวิธีรับมือเมื่อใช้แพลนฟรี การสลับบัญชีธุรกิจ และช่วงเวลาที่การแสดงผลมีผล
รายการสโคป OAuth และเงื่อนไขการใช้งาน
อธิบายรายการสโคปทั้งหมดที่ใช้ได้กับ OAuth API ของ ReceiptRoller และแต่ละสโคปจะให้สิทธิ์แก่แอปประเภทใด ครอบคลุมทั้งเงื่อนไขการตรวจสอบสโคปกลุ่ม User เหตุผลที่ไม่สามารถผสมสโคปกลุ่ม Store กับ User และวิธีใช้งานจากแอป LIFF
ภาพรวมของ Webhook
อธิบายชนิดอีเวนต์หลักที่ Webhook ของ ReceiptRoller ส่งมา เหตุผลที่ควรใช้ Webhook แทน polling รูปแบบการส่ง (HTTPS POST + JSON) และแนวคิดเรื่องการรับประกันการส่ง
ได้รับ 403/401 (สิทธิ์และสโคป)
การแยกแยะสาเหตุเมื่อการเรียก API ส่งคืน 401 หรือ 403 อธิบายกรณีทั่วไป เช่น โทเคนไม่ถูกต้อง สโคปไม่เพียงพอ ไม่มีสิทธิ์เข้าถึงร้านค้า และสโคปประเภท User ที่ยังไม่ผ่านการตรวจสอบ
สโคปประเภท User ส่งคืน app_not_approved
ขั้นตอนการตรวจสอบเมื่อใช้สโคปประเภท User แล้วได้รับข้อผิดพลาด app_not_approved อธิบายขั้นตอนการพัฒนาในโหมด sandbox การยื่นขอตรวจสอบ และการนำ sandbox ขึ้นสู่ production
รหัสข้อผิดพลาดและแนวทางการรีทราย
อธิบายรายการรหัสสถานะ HTTP และรหัสข้อผิดพลาดที่ API ของ ReceiptRoller ตอบกลับ กรณีที่ควรรีทราย และแนวทางการเว้นช่วงการรีทราย
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
การตรวจสอบลายเซ็นและความปลอดภัย
อธิบายกลไกการตรวจสอบลายเซ็น HMAC-SHA256 ของ Webhook ใน ReceiptRoller ตัวอย่างโค้ดตรวจสอบ (Node.js / Python / C#) มาตรการป้องกัน replay attack และวิธีจัดการ secret อย่างปลอดภัย
ข้อมูลบันทึกโฆษณาและการวัดประสิทธิภาพ
อธิบายโครงสร้างและวิธีดึงข้อมูลแคมเปญ คูปอง บันทึกโฆษณา และการวัดการมีส่วนช่วยต่อการซื้อ (Attribution) ที่ ReceiptRoller จัดการ
วิธีใช้ API ยอดขาย (Sales API)
คู่มือสรุปภาพรวมของ API ยอดขายของ ReceiptRoller (/api/v1/sales/*) และวิธีการกรองตามบัญชีธุรกิจ・ร้านค้า・เครื่อง POS・ช่วงเวลา ครอบคลุมโครงสร้างการตอบกลับจริง (KpiValue แบบซ้อน) รวมถึง averageTicket และอายุโทเคน (8 ชั่วโมง) เป็นคู่มือเริ่มต้นสำหรับสร้างแดชบอร์ดยอดขายในแอปมือถือ Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
เอนด์พอยต์และการกำหนดเวอร์ชัน
อธิบายเบส URL ของ ReceiptRoller API, นโยบายการกำหนดเวอร์ชัน, ขั้นตอนการแจ้งยกเลิกการใช้งาน และวิธีตรวจสอบเวอร์ชันปัจจุบัน
การหมุนเวียนซีเคร็ตและการจัดเก็บอย่างปลอดภัย
อธิบายแผนการหมุนเวียน (rotation) เพื่อใช้งานไคลเอนต์ซีเคร็ตและ Webhook ซีเคร็ตของ ReceiptRoller อย่างปลอดภัย, วิธีใช้ช่วงคู่ขนานระหว่างซีเคร็ตเก่ากับใหม่ และแนวปฏิบัติที่ดีในการจัดเก็บ