การจัดการไคลเอนต์ ID・ไคลเอนต์ซีเคร็ต
อธิบายวิธีขอไคลเอนต์ ID・ไคลเอนต์ซีเคร็ตที่ออกให้เมื่อลงทะเบียนแอปของ ReceiptRoller, กฎการจัดเก็บ, การจัดการเมื่อรั่วไหล และการใช้งานในหลายสภาพแวดล้อม
การขอและการอัปเดตแอ็กเซสโทเคน
อธิบายวิธีขอแอ็กเซสโทเคนและรีเฟรชโทเคนที่ใช้กับ ReceiptRoller API, อายุการใช้งาน, ขั้นตอนการอัปเดต และการจัดการเมื่อเกิดเออเรอร์
การลงทะเบียนแอปพลิเคชันคืออะไร
อธิบายแนวคิดของการลงทะเบียนแอปพลิเคชันใน ReceiptRoller การลงทะเบียนแอปในฐานะ OAuth client จะทำให้ได้ client ID・secret・redirect URI และเริ่มการเชื่อมต่อ API・Webhook ได้
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน
การมอนิเตอร์และการจัดการเมื่อล้มเหลว
อธิบายวิธีดูประวัติการส่ง Webhook ของ ReceiptRoller, ตัวชี้วัดที่ควรมอนิเตอร์และการออกแบบอะเลิร์ต, การส่ง dead letter ซ้ำ, รูปแบบเหตุขัดข้องที่พบบ่อยและขั้นตอนการกู้คืน
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ/แอปเซิร์ฟเวอร์ของ ReceiptRoller
PosTransactionDto สเปก — รีเฟอเรนซ์ฟิลด์ของข้อมูลธุรกรรม
อธิบายฟิลด์ทั้งหมดของ PosTransactionDto ซึ่งเป็นโมเดลมาตรฐานของข้อมูลธุรกรรมที่ ReceiptRoller จัดการ เป็นรีเฟอเรนซ์สำหรับนักพัฒนาและผู้ดูแลการเชื่อมต่อระบบภายนอก โดยสรุปชื่อฟิลด์・ชนิด・ความหมาย・วิธีที่แต่ละผู้ให้บริการ POS เติมค่าในแต่ละหมวด(ตัวระบุ・วันเวลา・จำนวนเงิน・รายการ・การชำระเงิน・สตาฟ・สถานะ・การเชื่อม CRM)ถูกอ้างอิงจากบทความแมปปิงของทั้ง スマレジ・Square
StaffDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ StaffDto ซึ่งเป็นมาสเตอร์สตาฟ(พนักงาน)ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การผูกกับ POS(Square Team / スマレジ)การอิงร้านค้า และรูปแบบการจ้างงาน
ข้อมูลด้านต่าง ๆ ที่ใช้ได้
อธิบายข้อมูลด้านต่าง ๆ ที่ดึงได้จากพอร์ทัลนักพัฒนาของ ReceiptRoller เป็นรายการ รวบรวมเนื้อหาที่อยู่ในแต่ละด้าน วิธีดึง และ scope ที่จำเป็น ครอบคลุมการซื้อ・สินค้า・สินค้าคงคลัง・คำสั่งซื้อ・ลูกค้า・คูปอง・SNS・โฆษณา・ข้อมูลผู้ใช้ส่วนบุคคล ฯลฯ
พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
การออกแบบการส่งซ้ำ・ลำดับ・idempotency
อธิบายนโยบายการส่งซ้ำของ Webhook ของ ReceiptRoller, เหตุผลที่ไม่รับประกันลำดับการส่ง, การอิมพลิเมนต์ idempotency ด้วย event_id, การจัดการ dead letter และแอนตี้แพตเทิร์นที่พบบ่อย
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่
อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
สำหรับแอปวอลเล็ต: คู่มือดึงใบเสร็จของผู้ใช้ผ่าน OAuth
อธิบายวิธีดึงใบเสร็จการซื้อของ Receipt Roller โดยได้รับความยินยอมจากผู้ใช้ ผ่านแอปแบบวอลเล็ต เช่น iOS, Android และ LINE Mini App ครอบคลุมการยืนยันตัวตน OAuth 2.0 การใช้ Receipt API และการเชื่อมต่อ Webhook
แนวคิดเรื่องการปกป้องข้อมูล (การทำให้ไม่ระบุตัวตนและการเข้ารหัส)
อธิบายแนวคิดเรื่องการปกป้องข้อมูลในแอปที่เชื่อมต่อ ReceiptRoller การเข้ารหัส (ขณะจัดเก็บและขณะส่ง) เทคนิคการทำให้ไม่ระบุตัวตนและการใช้นามแฝง และนโยบายการลบข้อมูล
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
SNS Webhook Bypass(การส่งต่อ Webhook ของ SNS ภายนอกอย่าง LINE)
อธิบายกลไก, วิธีตั้งค่า, การจัดการลายเซ็น และข้อควรระวัง ของฟีเจอร์ "SNS Webhook Bypass" ที่ ReceiptRoller ส่งต่อ Webhook ที่รับมาจากแพลตฟอร์ม SNS อย่าง LINE ไปยังแอปของนักพัฒนา ภายใต้ความยินยอมของฝั่งร้านค้า
การติดต่อฝ่ายสนับสนุน(สำหรับการเชื่อมต่อทางเทคนิค)
อธิบายประเภทของการสนับสนุนสำหรับนักพัฒนา ReceiptRoller เช็กลิสต์ก่อนติดต่อสอบถาม และเทมเพลตข้อมูลที่ควรแนบมาเพื่อให้แก้ปัญหาได้อย่างมีประสิทธิภาพ