ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
สำหรับแอปวอลเล็ต: คู่มือดึงใบเสร็จของผู้ใช้ผ่าน OAuth
อธิบายวิธีดึงใบเสร็จการซื้อของ Receipt Roller โดยได้รับความยินยอมจากผู้ใช้ ผ่านแอปแบบวอลเล็ต เช่น iOS, Android และ LINE Mini App ครอบคลุมการยืนยันตัวตน OAuth 2.0 การใช้ Receipt API และการเชื่อมต่อ Webhook
ข้อมูลด้านต่าง ๆ ที่ใช้ได้
อธิบายข้อมูลด้านต่าง ๆ ที่ดึงได้จากพอร์ทัลนักพัฒนาของ ReceiptRoller เป็นรายการ รวบรวมเนื้อหาที่อยู่ในแต่ละด้าน วิธีดึง และ scope ที่จำเป็น ครอบคลุมการซื้อ・สินค้า・สินค้าคงคลัง・คำสั่งซื้อ・ลูกค้า・คูปอง・SNS・โฆษณา・ข้อมูลผู้ใช้ส่วนบุคคล ฯลฯ
รายการสโคป OAuth และเงื่อนไขการใช้งาน
อธิบายรายการสโคปทั้งหมดที่ใช้ได้กับ OAuth API ของ ReceiptRoller และแต่ละสโคปจะให้สิทธิ์แก่แอปประเภทใด ครอบคลุมทั้งเงื่อนไขการตรวจสอบสโคปกลุ่ม User เหตุผลที่ไม่สามารถผสมสโคปกลุ่ม Store กับ User และวิธีใช้งานจากแอป LIFF
ขั้นตอนจนถึงเริ่มใช้งาน
อธิบายขั้นตอนจนถึงเริ่มใช้พอร์ทัลนักพัฒนาของ ReceiptRoller หากลงทะเบียนเป็นผู้ใช้ร้านค้าและเป็นแพลน Starter ขึ้นไป ก็สามารถเริ่มลงทะเบียนแอปและพัฒนา API ได้ทันทีโดยไม่ต้องยื่นคำขอเป็นนักพัฒนาต่างหาก
การเชื่อมต่อข้อมูลการซื้อและใบเสร็จ
อธิบายโครงสร้างข้อมูลการซื้อและใบเสร็จที่ ReceiptRoller จัดการ วิธีการดึงข้อมูล สโคปที่เกี่ยวข้อง Webhook และกรณีการใช้งานที่พบบ่อย
วิธีใช้ API ยอดขาย (Sales API)
คู่มือสรุปภาพรวมของ API ยอดขายของ ReceiptRoller (/api/v1/sales/*) และวิธีการกรองตามบัญชีธุรกิจ・ร้านค้า・เครื่อง POS・ช่วงเวลา ครอบคลุมโครงสร้างการตอบกลับจริง (KpiValue แบบซ้อน) รวมถึง averageTicket และอายุโทเคน (8 ชั่วโมง) เป็นคู่มือเริ่มต้นสำหรับสร้างแดชบอร์ดยอดขายในแอปมือถือ Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
การจัดการไคลเอนต์ ID・ไคลเอนต์ซีเคร็ต
อธิบายวิธีขอไคลเอนต์ ID・ไคลเอนต์ซีเคร็ตที่ออกให้เมื่อลงทะเบียนแอปของ ReceiptRoller, กฎการจัดเก็บ, การจัดการเมื่อรั่วไหล และการใช้งานในหลายสภาพแวดล้อม
วิธีใช้ Orders / OMS API
คู่มือการทำ CRUD กับคำสั่งซื้อภายใต้บัญชีธุรกิจ ผ่าน Orders / OMS API ของ ReceiptRoller (/api/v1/orders) รวบรวมการสร้าง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน・กำลังดำเนินการ・ยกเลิก)・ลบคำสั่งซื้อ และโฟลว์สำหรับแอป Android／iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่
อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC
แนวปฏิบัติที่ดีในการใช้งาน production
อธิบายแนวปฏิบัติที่ดีสำหรับการใช้งานแอปที่เชื่อมต่อ ReceiptRoller บน production (การแยก environment การเฝ้าติดตาม การ deploy การรับมือเหตุขัดข้อง และการจัดเตรียมเอกสาร)
วิธีใช้ Business Hours API
คู่มือ Business Hours API ของ ReceiptRoller (/api/v1/stores/{storeId}/business-hours) อธิบายการดึงและอัปเดตเวลาทำการรายวัน การลงทะเบียนวันเปิดทำการพิเศษ (หยุดกะทันหัน・เปลี่ยนเวลาทำการ) การตั้งค่าเวลาทำงานที่รับได้ของร้าน (เวลางานที่เป็นเพดานของการสร้างกะ) และการตัดสินว่าขณะนี้กำลังเปิดทำการอยู่หรือไม่
วิธีใช้ Reservations API
คู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
คู่มือการยืนยันตัวตน API
อธิบายวิธีการยืนยันตัวตนของ ReceiptRoller API ด้วย OAuth 2.0 authorization code flow
ProductDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ ProductDto ซึ่งเป็นมาสเตอร์สินค้า（PIM）ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การซิงก์แคตตาล็อกสินค้าจาก POS（Square）ต้นทุน・ราคารายร้าน・ตัวเลือกย่อย・สินค้าพรีออเดอร์
การตรวจสอบลายเซ็นและความปลอดภัย
อธิบายกลไกการตรวจสอบลายเซ็น HMAC-SHA256 ของ Webhook ใน ReceiptRoller ตัวอย่างโค้ดตรวจสอบ (Node.js / Python / C#) มาตรการป้องกัน replay attack และวิธีจัดการ secret อย่างปลอดภัย