พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
Webhook ไม่มาถึง
การแยกแยะสาเหตุเมื่อ Webhook ไม่มาถึง endpoint ผู้รับ อธิบายขั้นตอนการตรวจสอบตามลำดับ ทั้งการตั้งค่า endpoint การสมัครรับ event ความสามารถในการเข้าถึง ความล้มเหลวในการตรวจสอบลายเซ็น และไฟร์วอลล์
วิธีดู API reference และเอกสาร
อธิบายโครงสร้างและการเลือกใช้เอกสารสำหรับนักพัฒนาของ ReceiptRoller ครอบคลุมช่องทางเข้า 4 จุด ได้แก่ ศูนย์ช่วยเหลือนักพัฒนา・หน้ารวม API・API reference แบบ Swagger・คอมมิวนิตี้นักพัฒนา และวิธีดึงข้อมูลจำเพาะ OpenAPI (openapi/v1.json) สำหรับใช้กับผู้ช่วย AI และเครื่องมือสร้างโค้ด
SLA อัตราการทำงาน และขั้นตอนตรวจสอบเมื่อเกิดเหตุขัดข้อง
อธิบายเป้าหมายอัตราการทำงานของ ReceiptRoller API วิธีตรวจสอบหน้าสถานะ ขั้นตอนการแยกแยะสาเหตุเมื่อเกิดเหตุขัดข้อง และขั้นตอนการยกระดับสู่ฝ่ายสนับสนุน
ได้รับ 403/401 (สิทธิ์และสโคป)
การแยกแยะสาเหตุเมื่อการเรียก API ส่งคืน 401 หรือ 403 อธิบายกรณีทั่วไป เช่น โทเคนไม่ถูกต้อง สโคปไม่เพียงพอ ไม่มีสิทธิ์เข้าถึงร้านค้า และสโคปประเภท User ที่ยังไม่ผ่านการตรวจสอบ
เอนด์พอยต์และการกำหนดเวอร์ชัน
อธิบายเบส URL ของ ReceiptRoller API, นโยบายการกำหนดเวอร์ชัน, ขั้นตอนการแจ้งยกเลิกการใช้งาน และวิธีตรวจสอบเวอร์ชันปัจจุบัน
สโคปประเภท User ส่งคืน app_not_approved
ขั้นตอนการตรวจสอบเมื่อใช้สโคปประเภท User แล้วได้รับข้อผิดพลาด app_not_approved อธิบายขั้นตอนการพัฒนาในโหมด sandbox การยื่นขอตรวจสอบ และการนำ sandbox ขึ้นสู่ production
ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
รหัสข้อผิดพลาดและแนวทางการรีทราย
อธิบายรายการรหัสสถานะ HTTP และรหัสข้อผิดพลาดที่ API ของ ReceiptRoller ตอบกลับ กรณีที่ควรรีทราย และแนวทางการเว้นช่วงการรีทราย