สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
สำหรับร้านค้า: คู่มือออกใบเสร็จดิจิทัลในแอปของตนเองและแจ้งเตือนผ่าน Webhook
อธิบายขั้นตอนตั้งแต่การให้ร้านค้า/แบรนด์ออกใบเสร็จดิจิทัลให้ลูกค้าในแอปของตนเอง จนถึงการรับการแจ้งเตือนแบบเรียลไทม์ผ่าน Webhook ครอบคลุมการลงทะเบียนแอป OAuth การตั้งค่า Webhook และการตรวจสอบลายเซ็น
วิธีใช้ Inventory / WMS API
คู่มือการนำ Inventory / WMS API ของ ReceiptRoller ไปใช้งาน อธิบายวิธีดูและปรับสต็อกแยกตามโลเคชัน การดึงประวัติการเคลื่อนไหว OAuth สโคปที่จำเป็น การสะท้อนอัตโนมัติเมื่อเชื่อมต่อ Shopify และการใช้งานผ่าน MCP tool (wms_get_stock / wms_adjust_stock ฯลฯ)
วิธีใช้ Reservations API
คู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
วิธีใช้ Business Hours API
คู่มือ Business Hours API ของ ReceiptRoller (/api/v1/stores/{storeId}/business-hours) อธิบายการดึงและอัปเดตเวลาทำการรายวัน การลงทะเบียนวันเปิดทำการพิเศษ (หยุดกะทันหัน・เปลี่ยนเวลาทำการ) การตั้งค่าเวลาทำงานที่รับได้ของร้าน (เวลางานที่เป็นเพดานของการสร้างกะ) และการตัดสินว่าขณะนี้กำลังเปิดทำการอยู่หรือไม่
สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
ภาพรวมของสิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนาของ ReceiptRoller ผสมผสานการดึงและจัดการข้อมูลผ่าน REST API กับการรับอีเวนต์แบบเรียลไทม์ผ่าน Webhook เพื่อเชื่อมต่อข้อมูลร้านค้าและผู้ใช้จากระบบภายนอก
คู่มือสำหรับแอปมือถือเนทีฟ: การเข้าถึงหลายบัญชีธุรกิจและโฟลว์ OAuth
คู่มือการพัฒนาสำหรับแอปเนทีฟ Android / iOS เมื่อปิดตัวเลือก「ผูกโทเคนกับบัญชีธุรกิจเดียวตอนอนุมัติ」ตอนลงทะเบียนแอป ระบบจะออก access token แบบ user-scoped ทำให้เข้าถึงข้ามหลายบัญชีธุรกิจได้ด้วยแพตเทิร์น /api/v1/me/organizations ＋ ?organizationId=
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
สำหรับแอปวอลเล็ต: คู่มือดึงใบเสร็จของผู้ใช้ผ่าน OAuth
อธิบายวิธีดึงใบเสร็จการซื้อของ Receipt Roller โดยได้รับความยินยอมจากผู้ใช้ ผ่านแอปแบบวอลเล็ต เช่น iOS, Android และ LINE Mini App ครอบคลุมการยืนยันตัวตน OAuth 2.0 การใช้ Receipt API และการเชื่อมต่อ Webhook
การขอและการอัปเดตแอ็กเซสโทเคน
อธิบายวิธีขอแอ็กเซสโทเคนและรีเฟรชโทเคนที่ใช้กับ ReceiptRoller API, อายุการใช้งาน, ขั้นตอนการอัปเดต และการจัดการเมื่อเกิดเออเรอร์
พอร์ทัลนักพัฒนาไม่แสดงเมื่อยังใช้แพลนฟรี
ขั้นตอนการตรวจสอบเมื่อพอร์ทัลนักพัฒนาของ ReceiptRoller ไม่แสดง อธิบายวิธีรับมือเมื่อใช้แพลนฟรี การสลับบัญชีธุรกิจ และช่วงเวลาที่การแสดงผลมีผล
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่
อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC
ข้อมูลเกี่ยวกับบัญชีและใบแจ้งหนี้ (ขอบเขตการรองรับ)
อธิบายขอบเขตการรองรับข้อมูลบัญชีและใบแจ้งหนี้ที่ ReceiptRoller จัดการ รายงานภาษี การรองรับระบบใบกำกับภาษี (Invoice) และแนวทางการเชื่อมต่อกับซอฟต์แวร์บัญชี
การจัดการไคลเอนต์ ID・ไคลเอนต์ซีเคร็ต
อธิบายวิธีขอไคลเอนต์ ID・ไคลเอนต์ซีเคร็ตที่ออกให้เมื่อลงทะเบียนแอปของ ReceiptRoller, กฎการจัดเก็บ, การจัดการเมื่อรั่วไหล และการใช้งานในหลายสภาพแวดล้อม
การมอนิเตอร์และการจัดการเมื่อล้มเหลว
อธิบายวิธีดูประวัติการส่ง Webhook ของ ReceiptRoller, ตัวชี้วัดที่ควรมอนิเตอร์และการออกแบบอะเลิร์ต, การส่ง dead letter ซ้ำ, รูปแบบเหตุขัดข้องที่พบบ่อยและขั้นตอนการกู้คืน
พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
แนวปฏิบัติที่ดีในการใช้งาน production
อธิบายแนวปฏิบัติที่ดีสำหรับการใช้งานแอปที่เชื่อมต่อ ReceiptRoller บน production (การแยก environment การเฝ้าติดตาม การ deploy การรับมือเหตุขัดข้อง และการจัดเตรียมเอกสาร)
การออกแบบการส่งซ้ำ・ลำดับ・idempotency
อธิบายนโยบายการส่งซ้ำของ Webhook ของ ReceiptRoller, เหตุผลที่ไม่รับประกันลำดับการส่ง, การอิมพลิเมนต์ idempotency ด้วย event_id, การจัดการ dead letter และแอนตี้แพตเทิร์นที่พบบ่อย
ได้รับ 403/401 (สิทธิ์และสโคป)
การแยกแยะสาเหตุเมื่อการเรียก API ส่งคืน 401 หรือ 403 อธิบายกรณีทั่วไป เช่น โทเคนไม่ถูกต้อง สโคปไม่เพียงพอ ไม่มีสิทธิ์เข้าถึงร้านค้า และสโคปประเภท User ที่ยังไม่ผ่านการตรวจสอบ
การแจ้งวัตถุประสงค์การใช้งาน・ปลายทางเชื่อมต่อ（POS／EC／การวิเคราะห์ ฯลฯ）
อธิบายความหมาย, วิธีเลือก, ข้อควรระวังเมื่อเปลี่ยนแปลง ของ "วัตถุประสงค์การใช้งาน" และ "หมวดหมู่ปลายทางเชื่อมต่อ"（POS／EC／การวิเคราะห์／CRM／OMS／WMS／SNS／อื่นๆ）ที่แจ้งตอนลงทะเบียนแอปในพอร์ทัลนักพัฒนาของ ReceiptRoller และความเกี่ยวข้องกับการตรวจสอบสโคปตระกูล User