สำหรับแอปวอลเล็ต: คู่มือดึงใบเสร็จของผู้ใช้ผ่าน OAuth
อธิบายวิธีดึงใบเสร็จการซื้อของ Receipt Roller โดยได้รับความยินยอมจากผู้ใช้ ผ่านแอปแบบวอลเล็ต เช่น iOS, Android และ LINE Mini App ครอบคลุมการยืนยันตัวตน OAuth 2.0 การใช้ Receipt API และการเชื่อมต่อ Webhook
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
รายการสโคป OAuth และเงื่อนไขการใช้งาน
อธิบายรายการสโคปทั้งหมดที่ใช้ได้กับ OAuth API ของ ReceiptRoller และแต่ละสโคปจะให้สิทธิ์แก่แอปประเภทใด ครอบคลุมทั้งเงื่อนไขการตรวจสอบสโคปกลุ่ม User เหตุผลที่ไม่สามารถผสมสโคปกลุ่ม Store กับ User และวิธีใช้งานจากแอป LIFF
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
คู่มือสำหรับแอปมือถือเนทีฟ: การเข้าถึงหลายบัญชีธุรกิจและโฟลว์ OAuth
คู่มือการพัฒนาสำหรับแอปเนทีฟ Android / iOS เมื่อปิดตัวเลือก「ผูกโทเคนกับบัญชีธุรกิจเดียวตอนอนุมัติ」ตอนลงทะเบียนแอป ระบบจะออก access token แบบ user-scoped ทำให้เข้าถึงข้ามหลายบัญชีธุรกิจได้ด้วยแพตเทิร์น /api/v1/me/organizations ＋ ?organizationId=
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
สร้างแอปใหม่
อธิบายขั้นตอนที่เป็นรูปธรรมในการลงทะเบียนแอปใหม่ (OAuth client) ในพอร์ทัลนักพัฒนาของ ReceiptRoller ครอบคลุมตั้งแต่รายการที่ต้องกรอก การ validate การแสดง client secret หลังสร้าง ไปจนถึงข้อผิดพลาดที่พบบ่อย
การแจ้งวัตถุประสงค์การใช้งาน・ปลายทางเชื่อมต่อ（POS／EC／การวิเคราะห์ ฯลฯ）
อธิบายความหมาย, วิธีเลือก, ข้อควรระวังเมื่อเปลี่ยนแปลง ของ "วัตถุประสงค์การใช้งาน" และ "หมวดหมู่ปลายทางเชื่อมต่อ"（POS／EC／การวิเคราะห์／CRM／OMS／WMS／SNS／อื่นๆ）ที่แจ้งตอนลงทะเบียนแอปในพอร์ทัลนักพัฒนาของ ReceiptRoller และความเกี่ยวข้องกับการตรวจสอบสโคปตระกูล User
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
การลงทะเบียนแอปพลิเคชันคืออะไร
อธิบายแนวคิดของการลงทะเบียนแอปพลิเคชันใน ReceiptRoller การลงทะเบียนแอปในฐานะ OAuth client จะทำให้ได้ client ID・secret・redirect URI และเริ่มการเชื่อมต่อ API・Webhook ได้
สโคปประเภท User ส่งคืน app_not_approved
ขั้นตอนการตรวจสอบเมื่อใช้สโคปประเภท User แล้วได้รับข้อผิดพลาด app_not_approved อธิบายขั้นตอนการพัฒนาในโหมด sandbox การยื่นขอตรวจสอบ และการนำ sandbox ขึ้นสู่ production
ได้รับ 403/401 (สิทธิ์และสโคป)
การแยกแยะสาเหตุเมื่อการเรียก API ส่งคืน 401 หรือ 403 อธิบายกรณีทั่วไป เช่น โทเคนไม่ถูกต้อง สโคปไม่เพียงพอ ไม่มีสิทธิ์เข้าถึงร้านค้า และสโคปประเภท User ที่ยังไม่ผ่านการตรวจสอบ
CrmCustomerDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ CrmCustomerDto ซึ่งเป็นมาสเตอร์ลูกค้าของ ReceiptRoller ข้อมูลลูกค้าที่ดึงมาจาก POS（スマレジ・Square）จะถูกทำให้เป็นรูปแบบมาตรฐานตามโมเดลนี้
ขั้นตอนจนถึงเริ่มใช้งาน
อธิบายขั้นตอนจนถึงเริ่มใช้พอร์ทัลนักพัฒนาของ ReceiptRoller หากลงทะเบียนเป็นผู้ใช้ร้านค้าและเป็นแพลน Starter ขึ้นไป ก็สามารถเริ่มลงทะเบียนแอปและพัฒนา API ได้ทันทีโดยไม่ต้องยื่นคำขอเป็นนักพัฒนาต่างหาก
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
การตรวจสอบลายเซ็นและความปลอดภัย
อธิบายกลไกการตรวจสอบลายเซ็น HMAC-SHA256 ของ Webhook ใน ReceiptRoller ตัวอย่างโค้ดตรวจสอบ (Node.js / Python / C#) มาตรการป้องกัน replay attack และวิธีจัดการ secret อย่างปลอดภัย
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
StaffDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ StaffDto ซึ่งเป็นมาสเตอร์สตาฟ（พนักงาน）ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การผูกกับ POS（Square Team / スマレジ）การอิงร้านค้า และรูปแบบการจ้างงาน