รหัสข้อผิดพลาดและแนวทางการรีทราย
อธิบายรายการรหัสสถานะ HTTP และรหัสข้อผิดพลาดที่ API ของ ReceiptRoller ตอบกลับ กรณีที่ควรรีทราย และแนวทางการเว้นช่วงการรีทราย
SLA อัตราการทำงาน และขั้นตอนตรวจสอบเมื่อเกิดเหตุขัดข้อง
อธิบายเป้าหมายอัตราการทำงานของ ReceiptRoller API วิธีตรวจสอบหน้าสถานะ ขั้นตอนการแยกแยะสาเหตุเมื่อเกิดเหตุขัดข้อง และขั้นตอนการยกระดับสู่ฝ่ายสนับสนุน
พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
การตั้งค่า Redirect URL
อธิบายบทบาทของ redirect URI (callback URL) ที่ตั้งค่าในพอร์ทัลนักพัฒนาของ ReceiptRoller กฎการลงทะเบียน การแยกใช้สภาพแวดล้อม development กับ production และข้อผิดพลาดที่พบบ่อยพร้อมวิธีแก้ไข
วิธีใช้ Transactions API (ฟิลด์รวม POS + OMS)
Transactions API ของ ReceiptRoller เป็น API อ่านอย่างเดียวที่รวมยอดขายจากแคชเชียร์ (PosTransactions) และคำสั่งซื้อจากระบบจัดการการขาย (OmsOrders) ไว้ในฟีดเดียว เป็นจุดเริ่มต้นเมื่อต้องการแสดงรายการ "ธุรกรรมทั้งหมดของบัญชีธุรกิจ" ในแอป Android／iOS
การมอนิเตอร์และการจัดการเมื่อล้มเหลว
อธิบายวิธีดูประวัติการส่ง Webhook ของ ReceiptRoller, ตัวชี้วัดที่ควรมอนิเตอร์และการออกแบบอะเลิร์ต, การส่ง dead letter ซ้ำ, รูปแบบเหตุขัดข้องที่พบบ่อยและขั้นตอนการกู้คืน
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
สร้างแอปใหม่
อธิบายขั้นตอนที่เป็นรูปธรรมในการลงทะเบียนแอปใหม่ (OAuth client) ในพอร์ทัลนักพัฒนาของ ReceiptRoller ครอบคลุมตั้งแต่รายการที่ต้องกรอก การ validate การแสดง client secret หลังสร้าง ไปจนถึงข้อผิดพลาดที่พบบ่อย
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
วิธีใช้ Orders / OMS API
คู่มือการทำ CRUD กับคำสั่งซื้อภายใต้บัญชีธุรกิจ ผ่าน Orders / OMS API ของ ReceiptRoller (/api/v1/orders) รวบรวมการสร้าง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน・กำลังดำเนินการ・ยกเลิก)・ลบคำสั่งซื้อ และโฟลว์สำหรับแอป Android／iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Business Hours API
คู่มือ Business Hours API ของ ReceiptRoller (/api/v1/stores/{storeId}/business-hours) อธิบายการดึงและอัปเดตเวลาทำการรายวัน การลงทะเบียนวันเปิดทำการพิเศษ (หยุดกะทันหัน・เปลี่ยนเวลาทำการ) การตั้งค่าเวลาทำงานที่รับได้ของร้าน (เวลางานที่เป็นเพดานของการสร้างกะ) และการตัดสินว่าขณะนี้กำลังเปิดทำการอยู่หรือไม่
การลงทะเบียนแอปพลิเคชันคืออะไร
อธิบายแนวคิดของการลงทะเบียนแอปพลิเคชันใน ReceiptRoller การลงทะเบียนแอปในฐานะ OAuth client จะทำให้ได้ client ID・secret・redirect URI และเริ่มการเชื่อมต่อ API・Webhook ได้
การจำกัดอัตราการเรียก (Rate Limit) และการควบคุมปริมาณ
อธิบายหน่วยของการจำกัดอัตราการเรียก API ของ ReceiptRoller ค่าเพดานแยกตามแพลน วิธีอ่านเฮดเดอร์การตอบกลับ และรูปแบบการเขียนโค้ดเพื่อไม่ให้ชน 429
เอนด์พอยต์และการกำหนดเวอร์ชัน
อธิบายเบส URL ของ ReceiptRoller API, นโยบายการกำหนดเวอร์ชัน, ขั้นตอนการแจ้งยกเลิกการใช้งาน และวิธีตรวจสอบเวอร์ชันปัจจุบัน
วิธีใช้ Reservations API
คู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
CrmCustomerDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ CrmCustomerDto ซึ่งเป็นมาสเตอร์ลูกค้าของ ReceiptRoller ข้อมูลลูกค้าที่ดึงมาจาก POS（スマレジ・Square）จะถูกทำให้เป็นรูปแบบมาตรฐานตามโมเดลนี้