เอนด์พอยต์และการกำหนดเวอร์ชัน
API
เอนด์พอยต์
การกำหนดเวอร์ชัน
โครงสร้าง URL
บทความนี้เหมาะสำหรับใคร
สำหรับนักพัฒนาที่จะพัฒนาการเชื่อมต่อกับ ReceiptRoller 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 (22)
OAuth (15)
Android (10)
iOS (9)
Webhook (8)
api (7)
oauth (5)
getting-started (4)
การลงทะเบียนแอป (4)
การแก้ปัญหา (4)
บทความที่เกี่ยวข้อง
-
วิธีใช้ Reservations APIคู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
-
วิธีใช้ 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) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
-
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POSคู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ/แอปเซิร์ฟเวอร์ของ ReceiptRoller