การตั้งค่า Redirect URL
อธิบายบทบาทของ redirect URI (callback URL) ที่ตั้งค่าในพอร์ทัลนักพัฒนาของ ReceiptRoller กฎการลงทะเบียน การแยกใช้สภาพแวดล้อม development กับ production และข้อผิดพลาดที่พบบ่อยพร้อมวิธีแก้ไข
เอนด์พอยต์และการกำหนดเวอร์ชัน
อธิบายเบส URL ของ ReceiptRoller API, นโยบายการกำหนดเวอร์ชัน, ขั้นตอนการแจ้งยกเลิกการใช้งาน และวิธีตรวจสอบเวอร์ชันปัจจุบัน
วิธีดู API reference และเอกสาร
อธิบายโครงสร้างและการเลือกใช้เอกสารสำหรับนักพัฒนาของ ReceiptRoller ครอบคลุมช่องทางเข้า 4 จุด ได้แก่ ศูนย์ช่วยเหลือนักพัฒนา・หน้ารวม API・API reference แบบ Swagger・คอมมิวนิตี้นักพัฒนา และวิธีดึงข้อมูลจำเพาะ OpenAPI (openapi/v1.json) สำหรับใช้กับผู้ช่วย AI และเครื่องมือสร้างโค้ด
ขอโทเคนไม่ได้ (ข้อผิดพลาดการยืนยันตัวตน)
การแยกแยะสาเหตุเมื่อขอ access token ไม่ได้ อธิบายข้อผิดพลาดทั่วไป เช่น invalid_client, invalid_grant, redirect_uri_mismatch และวิธีรับมือ
สร้างแอปใหม่
อธิบายขั้นตอนที่เป็นรูปธรรมในการลงทะเบียนแอปใหม่ (OAuth client) ในพอร์ทัลนักพัฒนาของ ReceiptRoller ครอบคลุมตั้งแต่รายการที่ต้องกรอก การ validate การแสดง client secret หลังสร้าง ไปจนถึงข้อผิดพลาดที่พบบ่อย
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
การลงทะเบียนแอปพลิเคชันคืออะไร
อธิบายแนวคิดของการลงทะเบียนแอปพลิเคชันใน ReceiptRoller การลงทะเบียนแอปในฐานะ OAuth client จะทำให้ได้ client ID・secret・redirect URI และเริ่มการเชื่อมต่อ API・Webhook ได้
การแจ้งวัตถุประสงค์การใช้งาน・ปลายทางเชื่อมต่อ（POS／EC／การวิเคราะห์ ฯลฯ）
อธิบายความหมาย, วิธีเลือก, ข้อควรระวังเมื่อเปลี่ยนแปลง ของ "วัตถุประสงค์การใช้งาน" และ "หมวดหมู่ปลายทางเชื่อมต่อ"（POS／EC／การวิเคราะห์／CRM／OMS／WMS／SNS／อื่นๆ）ที่แจ้งตอนลงทะเบียนแอปในพอร์ทัลนักพัฒนาของ ReceiptRoller และความเกี่ยวข้องกับการตรวจสอบสโคปตระกูล User
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
วิธีลงทะเบียน Webhook
อธิบายขั้นตอนการลงทะเบียน Webhook endpoint ในพอร์ทัลนักพัฒนาของ ReceiptRoller วิธีเลือกอีเวนต์ที่ต้องการสมัครรับ การส่งทดสอบ การแบ่งใช้หลาย endpoint และวิธีลบหรือปิดใช้งานชั่วคราว
การยื่นขอตรวจสอบสำหรับสโคปตระกูล User
อธิบายขั้นตอนการยื่นขอตรวจสอบ, เอกสารที่ต้องส่ง, เกณฑ์การตรวจสอบ, ระยะเวลาตรวจสอบ และเหตุผลที่ถูกตีกลับที่พบบ่อย สำหรับแอปที่ต้องจัดการข้อมูลของผู้บริโภคทั่วไป (สโคป user.*) ใน ReceiptRoller
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
Webhook ไม่มาถึง
การแยกแยะสาเหตุเมื่อ Webhook ไม่มาถึง endpoint ผู้รับ อธิบายขั้นตอนการตรวจสอบตามลำดับ ทั้งการตั้งค่า endpoint การสมัครรับ event ความสามารถในการเข้าถึง ความล้มเหลวในการตรวจสอบลายเซ็น และไฟร์วอลล์
การมอนิเตอร์และการจัดการเมื่อล้มเหลว
อธิบายวิธีดูประวัติการส่ง Webhook ของ ReceiptRoller, ตัวชี้วัดที่ควรมอนิเตอร์และการออกแบบอะเลิร์ต, การส่ง dead letter ซ้ำ, รูปแบบเหตุขัดข้องที่พบบ่อยและขั้นตอนการกู้คืน
ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
PosTransactionDto สเปก — รีเฟอเรนซ์ฟิลด์ของข้อมูลธุรกรรม
อธิบายฟิลด์ทั้งหมดของ PosTransactionDto ซึ่งเป็นโมเดลมาตรฐานของข้อมูลธุรกรรมที่ ReceiptRoller จัดการ เป็นรีเฟอเรนซ์สำหรับนักพัฒนาและผู้ดูแลการเชื่อมต่อระบบภายนอก โดยสรุปชื่อฟิลด์・ชนิด・ความหมาย・วิธีที่แต่ละผู้ให้บริการ POS เติมค่าในแต่ละหมวด（ตัวระบุ・วันเวลา・จำนวนเงิน・รายการ・การชำระเงิน・สตาฟ・สถานะ・การเชื่อม CRM）ถูกอ้างอิงจากบทความแมปปิงของทั้ง スマレジ・Square
ภาพรวมของ Webhook
อธิบายชนิดอีเวนต์หลักที่ Webhook ของ ReceiptRoller ส่งมา เหตุผลที่ควรใช้ Webhook แทน polling รูปแบบการส่ง (HTTPS POST + JSON) และแนวคิดเรื่องการรับประกันการส่ง
สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
ภาพรวมของสิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนาของ ReceiptRoller ผสมผสานการดึงและจัดการข้อมูลผ่าน REST API กับการรับอีเวนต์แบบเรียลไทม์ผ่าน Webhook เพื่อเชื่อมต่อข้อมูลร้านค้าและผู้ใช้จากระบบภายนอก
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์