ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
วิธีใช้ API ยอดขาย (Sales API)
คู่มือสรุปภาพรวมของ API ยอดขายของ ReceiptRoller (/api/v1/sales/*) และวิธีการกรองตามบัญชีธุรกิจ・ร้านค้า・เครื่อง POS・ช่วงเวลา ครอบคลุมโครงสร้างการตอบกลับจริง (KpiValue แบบซ้อน) รวมถึง averageTicket และอายุโทเคน (8 ชั่วโมง) เป็นคู่มือเริ่มต้นสำหรับสร้างแดชบอร์ดยอดขายในแอปมือถือ Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
ข้อมูลด้านต่าง ๆ ที่ใช้ได้
อธิบายข้อมูลด้านต่าง ๆ ที่ดึงได้จากพอร์ทัลนักพัฒนาของ ReceiptRoller เป็นรายการ รวบรวมเนื้อหาที่อยู่ในแต่ละด้าน วิธีดึง และ scope ที่จำเป็น ครอบคลุมการซื้อ・สินค้า・สินค้าคงคลัง・คำสั่งซื้อ・ลูกค้า・คูปอง・SNS・โฆษณา・ข้อมูลผู้ใช้ส่วนบุคคล ฯลฯ
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
การจำกัดอัตราการเรียก (Rate Limit) และการควบคุมปริมาณ
อธิบายหน่วยของการจำกัดอัตราการเรียก API ของ ReceiptRoller ค่าเพดานแยกตามแพลน วิธีอ่านเฮดเดอร์การตอบกลับ และรูปแบบการเขียนโค้ดเพื่อไม่ให้ชน 429
ขั้นตอนจนถึงเริ่มใช้งาน
อธิบายขั้นตอนจนถึงเริ่มใช้พอร์ทัลนักพัฒนาของ ReceiptRoller หากลงทะเบียนเป็นผู้ใช้ร้านค้าและเป็นแพลน Starter ขึ้นไป ก็สามารถเริ่มลงทะเบียนแอปและพัฒนา API ได้ทันทีโดยไม่ต้องยื่นคำขอเป็นนักพัฒนาต่างหาก
แนวคิดเรื่องการปกป้องข้อมูล (การทำให้ไม่ระบุตัวตนและการเข้ารหัส)
อธิบายแนวคิดเรื่องการปกป้องข้อมูลในแอปที่เชื่อมต่อ ReceiptRoller การเข้ารหัส (ขณะจัดเก็บและขณะส่ง) เทคนิคการทำให้ไม่ระบุตัวตนและการใช้นามแฝง และนโยบายการลบข้อมูล
วิธีใช้ Orders / OMS API
คู่มือการทำ CRUD กับคำสั่งซื้อภายใต้บัญชีธุรกิจ ผ่าน Orders / OMS API ของ ReceiptRoller (/api/v1/orders) รวบรวมการสร้าง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน・กำลังดำเนินการ・ยกเลิก)・ลบคำสั่งซื้อ และโฟลว์สำหรับแอป Android／iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน
รายการสโคป OAuth และเงื่อนไขการใช้งาน
อธิบายรายการสโคปทั้งหมดที่ใช้ได้กับ OAuth API ของ ReceiptRoller และแต่ละสโคปจะให้สิทธิ์แก่แอปประเภทใด ครอบคลุมทั้งเงื่อนไขการตรวจสอบสโคปกลุ่ม User เหตุผลที่ไม่สามารถผสมสโคปกลุ่ม Store กับ User และวิธีใช้งานจากแอป LIFF
การยื่นขอตรวจสอบสำหรับสโคปตระกูล User
อธิบายขั้นตอนการยื่นขอตรวจสอบ, เอกสารที่ต้องส่ง, เกณฑ์การตรวจสอบ, ระยะเวลาตรวจสอบ และเหตุผลที่ถูกตีกลับที่พบบ่อย สำหรับแอปที่ต้องจัดการข้อมูลของผู้บริโภคทั่วไป (สโคป user.*) ใน ReceiptRoller
PosTransactionDto สเปก — รีเฟอเรนซ์ฟิลด์ของข้อมูลธุรกรรม
อธิบายฟิลด์ทั้งหมดของ PosTransactionDto ซึ่งเป็นโมเดลมาตรฐานของข้อมูลธุรกรรมที่ ReceiptRoller จัดการ เป็นรีเฟอเรนซ์สำหรับนักพัฒนาและผู้ดูแลการเชื่อมต่อระบบภายนอก โดยสรุปชื่อฟิลด์・ชนิด・ความหมาย・วิธีที่แต่ละผู้ให้บริการ POS เติมค่าในแต่ละหมวด（ตัวระบุ・วันเวลา・จำนวนเงิน・รายการ・การชำระเงิน・สตาฟ・สถานะ・การเชื่อม CRM）ถูกอ้างอิงจากบทความแมปปิงของทั้ง スマレジ・Square
คู่มือการยืนยันตัวตน API
อธิบายวิธีการยืนยันตัวตนของ ReceiptRoller API ด้วย OAuth 2.0 authorization code flow