ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
ขั้นตอนจนถึงเริ่มใช้งาน
อธิบายขั้นตอนจนถึงเริ่มใช้พอร์ทัลนักพัฒนาของ ReceiptRoller หากลงทะเบียนเป็นผู้ใช้ร้านค้าและเป็นแพลน Starter ขึ้นไป ก็สามารถเริ่มลงทะเบียนแอปและพัฒนา API ได้ทันทีโดยไม่ต้องยื่นคำขอเป็นนักพัฒนาต่างหาก
ได้รับ 403/401 (สิทธิ์และสโคป)
การแยกแยะสาเหตุเมื่อการเรียก API ส่งคืน 401 หรือ 403 อธิบายกรณีทั่วไป เช่น โทเคนไม่ถูกต้อง สโคปไม่เพียงพอ ไม่มีสิทธิ์เข้าถึงร้านค้า และสโคปประเภท User ที่ยังไม่ผ่านการตรวจสอบ
วิธีใช้ Inventory / WMS API
คู่มือการนำ Inventory / WMS API ของ ReceiptRoller ไปใช้งาน อธิบายวิธีดูและปรับสต็อกแยกตามโลเคชัน การดึงประวัติการเคลื่อนไหว OAuth สโคปที่จำเป็น การสะท้อนอัตโนมัติเมื่อเชื่อมต่อ Shopify และการใช้งานผ่าน MCP tool (wms_get_stock / wms_adjust_stock ฯลฯ)
การออกแบบการส่งซ้ำ・ลำดับ・idempotency
อธิบายนโยบายการส่งซ้ำของ Webhook ของ ReceiptRoller, เหตุผลที่ไม่รับประกันลำดับการส่ง, การอิมพลิเมนต์ idempotency ด้วย event_id, การจัดการ dead letter และแอนตี้แพตเทิร์นที่พบบ่อย
แนวปฏิบัติที่ดีในการใช้งาน production
อธิบายแนวปฏิบัติที่ดีสำหรับการใช้งานแอปที่เชื่อมต่อ ReceiptRoller บน production (การแยก environment การเฝ้าติดตาม การ deploy การรับมือเหตุขัดข้อง และการจัดเตรียมเอกสาร)
การยื่นขอตรวจสอบสำหรับสโคปตระกูล User
อธิบายขั้นตอนการยื่นขอตรวจสอบ, เอกสารที่ต้องส่ง, เกณฑ์การตรวจสอบ, ระยะเวลาตรวจสอบ และเหตุผลที่ถูกตีกลับที่พบบ่อย สำหรับแอปที่ต้องจัดการข้อมูลของผู้บริโภคทั่วไป (สโคป user.*) ใน ReceiptRoller
วิธีลงทะเบียน Webhook
อธิบายขั้นตอนการลงทะเบียน Webhook endpoint ในพอร์ทัลนักพัฒนาของ ReceiptRoller วิธีเลือกอีเวนต์ที่ต้องการสมัครรับ การส่งทดสอบ การแบ่งใช้หลาย endpoint และวิธีลบหรือปิดใช้งานชั่วคราว
การขอและการอัปเดตแอ็กเซสโทเคน
อธิบายวิธีขอแอ็กเซสโทเคนและรีเฟรชโทเคนที่ใช้กับ ReceiptRoller API, อายุการใช้งาน, ขั้นตอนการอัปเดต และการจัดการเมื่อเกิดเออเรอร์
การตั้งค่า Redirect URL
อธิบายบทบาทของ redirect URI (callback URL) ที่ตั้งค่าในพอร์ทัลนักพัฒนาของ ReceiptRoller กฎการลงทะเบียน การแยกใช้สภาพแวดล้อม development กับ production และข้อผิดพลาดที่พบบ่อยพร้อมวิธีแก้ไข
การจำกัดอัตราการเรียก (Rate Limit) และการควบคุมปริมาณ
อธิบายหน่วยของการจำกัดอัตราการเรียก API ของ ReceiptRoller ค่าเพดานแยกตามแพลน วิธีอ่านเฮดเดอร์การตอบกลับ และรูปแบบการเขียนโค้ดเพื่อไม่ให้ชน 429
การติดต่อฝ่ายสนับสนุน（สำหรับการเชื่อมต่อทางเทคนิค）
อธิบายประเภทของการสนับสนุนสำหรับนักพัฒนา ReceiptRoller เช็กลิสต์ก่อนติดต่อสอบถาม และเทมเพลตข้อมูลที่ควรแนบมาเพื่อให้แก้ปัญหาได้อย่างมีประสิทธิภาพ
ขอโทเคนไม่ได้ (ข้อผิดพลาดการยืนยันตัวตน)
การแยกแยะสาเหตุเมื่อขอ access token ไม่ได้ อธิบายข้อผิดพลาดทั่วไป เช่น invalid_client, invalid_grant, redirect_uri_mismatch และวิธีรับมือ
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
การเชื่อมต่อข้อมูลการซื้อและใบเสร็จ
อธิบายโครงสร้างข้อมูลการซื้อและใบเสร็จที่ ReceiptRoller จัดการ วิธีการดึงข้อมูล สโคปที่เกี่ยวข้อง Webhook และกรณีการใช้งานที่พบบ่อย
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
ภาพรวมของสิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนาของ ReceiptRoller ผสมผสานการดึงและจัดการข้อมูลผ่าน REST API กับการรับอีเวนต์แบบเรียลไทม์ผ่าน Webhook เพื่อเชื่อมต่อข้อมูลร้านค้าและผู้ใช้จากระบบภายนอก
การควบคุมการเข้าถึงและ audit log
อธิบายการออกแบบการควบคุมการเข้าถึงในการใช้งานแอปที่เชื่อมต่อ ReceiptRoller หลักสิทธิ์ขั้นต่ำ วิธีเก็บ audit log และการทำรีวิวตามระยะ
การเชื่อมต่อข้อมูลสต็อกสินค้า
อธิบายโครงสร้างข้อมูลสต็อกของ ReceiptRoller การจัดการหลายคลังสินค้า ประวัติการรับ-จ่ายสินค้า การซิงค์แบบเรียลไทม์ด้วย Webhook และรูปแบบการเชื่อมต่อกับ WMS