เอนด์พอยต์และการกำหนดเวอร์ชัน

API เอนด์พอยต์ การกำหนดเวอร์ชัน โครงสร้าง URL
บทความนี้เหมาะสำหรับใคร
สำหรับนักพัฒนาที่จะพัฒนาการเชื่อมต่อกับ ReceiptRoller API บทความนี้อธิบายโครงสร้าง URL ของเอนด์พอยต์และแนวคิดเรื่องการกำหนดเวอร์ชัน

เบส URL

โปรดักชัน: https://api.receiptroller.io/v1
สเตจจิง: https://api-staging.receiptroller.io/v1

เอนด์พอยต์สำหรับการอนุญาต OAuth อยู่คนละโฮสต์

อนุญาต: https://receiptroller.io/oauth/authorize
โทเคน: https://receiptroller.io/oauth/token

โครงสร้าง URL

/v{เวอร์ชัน}/{รีซอร์ส}[/{ID}][/{ซับรีซอร์ส}]

ตัวอย่าง:
GET  /v1/receipts                  ← รายการใบเสร็จ
GET  /v1/receipts/rcp_xyz123       ← ใบเสร็จรายการเดียว
GET  /v1/receipts/rcp_xyz123/items ← รายละเอียดของใบเสร็จ
POST /v1/products                  ← สร้างสินค้า

นโยบายการกำหนดเวอร์ชัน

  • ใช้รูปแบบระบุเวอร์ชันใน URL path/v1/...)เราไม่ใช้รูปแบบระบุผ่านเฮดเดอร์
  • การเปลี่ยนแปลงที่เข้ากันได้กับเวอร์ชันเดิม(เช่น การเพิ่มฟิลด์)จะดำเนินการภายในเวอร์ชันเดียวกัน
  • การเปลี่ยนแปลงที่ทำลายความเข้ากันได้(การลบฟิลด์・เปลี่ยนชนิดข้อมูล・เปลี่ยน URL)จะให้บริการเป็นเวอร์ชันใหม่(/v2
  • หลังจากเปิดตัวเวอร์ชันใหม่ เวอร์ชันเก่าจะยังคงทำงานคู่ขนานกันเป็นเวลาอย่างน้อย 12 เดือน

การเปลี่ยนแปลงที่ถือว่าเข้ากันได้กับเวอร์ชันเดิม

  • การเพิ่มฟิลด์ใหม่ในเรสปอนส์
  • การเพิ่มเอนด์พอยต์ใหม่
  • การเพิ่มพารามิเตอร์ริเควสต์แบบไม่บังคับ
  • การเพิ่มโค้ดใหม่ในเออเรอร์โค้ดที่มีอยู่เดิม

หากตอนพัฒนาฝั่งไคลเอนต์ ออกแบบให้เพิกเฉยต่อฟิลด์ที่ไม่รู้จัก ก็จะช่วยให้รักษาความเข้ากันได้ง่ายขึ้น

ตัวอย่างการเปลี่ยนแปลงที่ทำลายความเข้ากันได้

  • การลบหรือเปลี่ยนชื่อฟิลด์ที่มีอยู่เดิม
  • การเปลี่ยนชนิดข้อมูลของฟิลด์(string → number เป็นต้น)
  • การเพิ่มพารามิเตอร์ริเควสต์แบบบังคับ
  • การเปลี่ยนวิธีการยืนยันตัวตน
  • การปรับลดขีดจำกัดอัตราการเรียก (rate limit) อย่างมาก

การแจ้งยกเลิกการใช้งานและระยะเวลาสนับสนุน

เฟส ระยะเวลา พฤติกรรม
ปกติทำงานได้โดยไม่มีปัญหา
แจ้งยกเลิกตั้งแต่ 12 เดือนก่อนยกเลิกเฮดเดอร์ Sunset ในเรสปอนส์
ไม่แนะนำตั้งแต่ 3 เดือนก่อนยกเลิกเพิ่มเฮดเดอร์ Deprecation
ยกเลิกตั้งแต่วันยกเลิกเป็นต้นไป410 Gone

การแจ้งยกเลิกจะแจ้งผ่าน "ประกาศ" ในพอร์ทัลนักพัฒนา, อีเมล และเฮดเดอร์ Sunset

การตรวจสอบเวอร์ชันปัจจุบัน

เฮดเดอร์เรสปอนส์ X-RR-Api-Version จะมีเวอร์ชันที่ประมวลผลอยู่ในปัจจุบัน

HTTP/1.1 200 OK
X-RR-Api-Version: 2026-04-01
Content-Type: application/json

คู่มือที่เกี่ยวข้อง

วันที่เผยแพร่: 2569-04-27 วันที่อัปเดต: 2569-07-05
このトピックについて
開発者API
機能の詳細を見る
แท็ก
API (22) OAuth (15) Android (10) iOS (9) Webhook (8) api (7) oauth (5) getting-started (4) การลงทะเบียนแอป (4) การแก้ปัญหา (4)
บทความที่เกี่ยวข้อง