วิธีดู API reference และเอกสาร

เอกสารสำหรับนักพัฒนาของ ReceiptRoller แบ่งเป็นช่องทางเข้าหลัก 4 จุดตามวัตถุประสงค์ ในศูนย์ช่วยเหลือนี้จะอธิบายแนวคิดและ use case ส่วนข้อกำหนดที่แม่นยำของ endpoint ให้ดูที่ reference และข้อสงสัยให้ถามที่คอมมิวนิตี้ นี่คือการเลือกใช้แต่ละช่องทาง

ช่องทางเข้า 4 จุด

1. ศูนย์ช่วยเหลือนักพัฒนา (ไซต์นี้)

คือไซต์ที่คุณกำลังอ่านอยู่ตอนนี้ รวบรวมคำอธิบายแนวคิด・แนวทางการพัฒนา・วิธีดำเนินงานแยกตาม use case ไว้ มีไว้เพื่อรู้ว่า「โดยรวมแล้วสร้างอย่างไร」ไม่ใช่「ข้อกำหนดของ endpoint เฉพาะตัว」

• ผู้เริ่มต้นเริ่มจาก สิ่งที่ทำได้ในพอร์ทัลนักพัฒนา
• ต้องการรู้ว่าดึงข้อมูลด้านใดได้บ้าง ดูที่ ข้อมูลด้านต่าง ๆ ที่ใช้ได้
• รายการ OAuth scope ดูที่ รายการ OAuth scope และการใช้ได้/ไม่ได้
• วิธีดำเนินการพัฒนาที่เป็นรูปธรรม ไปที่แต่ละคู่มือจาก สารบัญ

2. หน้ารวม API

https://receiptroller.io/th-TH/api/top

เป็นหน้ารวมของ ReceiptRoller API รวบรวม endpoint ยอดนิยมที่ใช้บ่อย (API ยอดฮิต) พร้อมตัวอย่างแบบง่ายไว้เป็นรายการ

• ใช้แบบนี้ — ช่องทางเข้าเมื่ออยากเริ่มลงมือให้เร็วที่สุด เช่น「อยากลองดึงข้อมูลธุรกรรมก่อน」「endpoint สำหรับดึงใบเสร็จของผู้ใช้อันไหน？」
• แต่ละ endpoint จะแสดงscope ที่จำเป็นและคำขอตัวอย่าง
• หากต้องการข้อกำหนดโดยละเอียด สามารถไปยัง reference ในหัวข้อถัดไปได้จากแต่ละ endpoint

3. API reference (Swagger / OpenAPI)

https://receiptroller.io/docs/api/reference

เป็นreference ฉบับสมบูรณ์ของทุก endpoint สร้างขึ้นด้วยข้อกำหนด OpenAPI (Swagger) สามารถตรวจสอบได้ครบทั้งพารามิเตอร์・ตัวคำขอ・ตัว response・error code

• ใช้แบบนี้ — เมื่อต้องการยืนยัน「พารามิเตอร์นี้ละเว้นได้ไหม？」「โครงสร้าง JSON ของ response ที่แม่นยำคืออะไร？」「endpoint นี้คืน error แบบไหน？」
• จัดระเบียบตามหมวดหมู่ (Store / CRM / SNS / Analytics / User / Survey ฯลฯ)
• แต่ละ endpoint แสดงscope ที่จำเป็นด้วย badge อย่างชัดเจน
• ปุ่ม「Try it out」ให้ลองส่งคำขอโดยตรงจากเบราว์เซอร์ได้ (ต้องมี token)

การดึงข้อกำหนด OpenAPI (machine-readable) โดยตรง

เราเผยแพร่ข้อกำหนด OpenAPI ต้นฉบับที่เป็นที่มาของ reference ไว้ที่ URL ต่อไปนี้

https://receiptroller.io/openapi/v1.json

• …