พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
ภาพรวมของ Webhook
อธิบายชนิดอีเวนต์หลักที่ Webhook ของ ReceiptRoller ส่งมา เหตุผลที่ควรใช้ Webhook แทน polling รูปแบบการส่ง (HTTPS POST + JSON) และแนวคิดเรื่องการรับประกันการส่ง
วิธีดู API reference และเอกสาร
อธิบายโครงสร้างและการเลือกใช้เอกสารสำหรับนักพัฒนาของ ReceiptRoller ครอบคลุมช่องทางเข้า 4 จุด ได้แก่ ศูนย์ช่วยเหลือนักพัฒนา・หน้ารวม API・API reference แบบ Swagger・คอมมิวนิตี้นักพัฒนา และวิธีดึงข้อมูลจำเพาะ OpenAPI (openapi/v1.json) สำหรับใช้กับผู้ช่วย AI และเครื่องมือสร้างโค้ด
PosTransactionDto สเปก — รีเฟอเรนซ์ฟิลด์ของข้อมูลธุรกรรม
อธิบายฟิลด์ทั้งหมดของ PosTransactionDto ซึ่งเป็นโมเดลมาตรฐานของข้อมูลธุรกรรมที่ ReceiptRoller จัดการ เป็นรีเฟอเรนซ์สำหรับนักพัฒนาและผู้ดูแลการเชื่อมต่อระบบภายนอก โดยสรุปชื่อฟิลด์・ชนิด・ความหมาย・วิธีที่แต่ละผู้ให้บริการ POS เติมค่าในแต่ละหมวด(ตัวระบุ・วันเวลา・จำนวนเงิน・รายการ・การชำระเงิน・สตาฟ・สถานะ・การเชื่อม CRM)ถูกอ้างอิงจากบทความแมปปิงของทั้ง スマレジ・Square
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
สำหรับแอปวอลเล็ต: คู่มือดึงใบเสร็จของผู้ใช้ผ่าน OAuth
อธิบายวิธีดึงใบเสร็จการซื้อของ Receipt Roller โดยได้รับความยินยอมจากผู้ใช้ ผ่านแอปแบบวอลเล็ต เช่น iOS, Android และ LINE Mini App ครอบคลุมการยืนยันตัวตน OAuth 2.0 การใช้ Receipt API และการเชื่อมต่อ Webhook
SNS Webhook Bypass(การส่งต่อ Webhook ของ SNS ภายนอกอย่าง LINE)
อธิบายกลไก, วิธีตั้งค่า, การจัดการลายเซ็น และข้อควรระวัง ของฟีเจอร์ "SNS Webhook Bypass" ที่ ReceiptRoller ส่งต่อ Webhook ที่รับมาจากแพลตฟอร์ม SNS อย่าง LINE ไปยังแอปของนักพัฒนา ภายใต้ความยินยอมของฝั่งร้านค้า
ขอโทเคนไม่ได้ (ข้อผิดพลาดการยืนยันตัวตน)
การแยกแยะสาเหตุเมื่อขอ access token ไม่ได้ อธิบายข้อผิดพลาดทั่วไป เช่น invalid_client, invalid_grant, redirect_uri_mismatch และวิธีรับมือ
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ 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
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
วิธีใช้ Inventory / WMS API
คู่มือการนำ Inventory / WMS API ของ ReceiptRoller ไปใช้งาน อธิบายวิธีดูและปรับสต็อกแยกตามโลเคชัน การดึงประวัติการเคลื่อนไหว OAuth สโคปที่จำเป็น การสะท้อนอัตโนมัติเมื่อเชื่อมต่อ Shopify และการใช้งานผ่าน MCP tool (wms_get_stock / wms_adjust_stock ฯลฯ)
คู่มือสำหรับแอปมือถือเนทีฟ: การเข้าถึงหลายบัญชีธุรกิจและโฟลว์ OAuth
คู่มือการพัฒนาสำหรับแอปเนทีฟ Android / iOS เมื่อปิดตัวเลือก「ผูกโทเคนกับบัญชีธุรกิจเดียวตอนอนุมัติ」ตอนลงทะเบียนแอป ระบบจะออก access token แบบ user-scoped ทำให้เข้าถึงข้ามหลายบัญชีธุรกิจได้ด้วยแพตเทิร์น /api/v1/me/organizations + ?organizationId=
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
ProductDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ ProductDto ซึ่งเป็นมาสเตอร์สินค้า(PIM)ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การซิงก์แคตตาล็อกสินค้าจาก POS(Square)ต้นทุน・ราคารายร้าน・ตัวเลือกย่อย・สินค้าพรีออเดอร์
การตรวจสอบลายเซ็นและความปลอดภัย
อธิบายกลไกการตรวจสอบลายเซ็น HMAC-SHA256 ของ Webhook ใน ReceiptRoller ตัวอย่างโค้ดตรวจสอบ (Node.js / Python / C#) มาตรการป้องกัน replay attack และวิธีจัดการ secret อย่างปลอดภัย
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่
อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC