คำแนะนำนี้อธิบายวิธีที่ Merchant API จัดการการกำหนดเวอร์ชัน การเผยแพร่ และวงจรการใช้งานของเวอร์ชันต่างๆ
รูปแบบการกำหนดเวอร์ชัน
Merchant API ใช้กลยุทธ์การกำหนดเวอร์ชันที่ระดับ API ย่อย ซึ่งหมายความว่า Merchant API แต่ละรายการ เช่น ผลิตภัณฑ์ภายใน Merchant API จะมีวงจรการใช้งานเวอร์ชันของตัวเอง
รูปแบบและการนำเสนอการกำหนดเวอร์ชัน
เวอร์ชัน API ย่อยที่เสถียร: หาก API ย่อยอยู่ในเวอร์ชันเสถียร เมธอดทั้งหมดของ API ย่อยนั้นก็จะอยู่ในเวอร์ชันเสถียรด้วย เวอร์ชัน API ย่อยที่เสถียรจะแสดง เป็น vX (เช่น v1, v2) ซึ่งเป็นเวอร์ชันหลักที่พร้อมใช้งานจริง
เวอร์ชัน API ย่อยแบบอัลฟ่า: หาก API ย่อยอยู่ในเวอร์ชันอัลฟ่า เมธอดทั้งหมดของ API ย่อยนั้นก็จะอยู่ในเวอร์ชันอัลฟ่าด้วย เวอร์ชัน API ย่อยแบบอัลฟ่าจะแสดงเป็น vXalpha (เช่น v1alpha, v2alpha) โดยจะมีฟีเจอร์ทดลองใช้แบบทดลองและแบบทดลองใช้ก่อนเปิดตัว ซึ่งมีไว้สำหรับการทดสอบและการทำซ้ำอย่างรวดเร็ว เวอร์ชันอัลฟ่าไม่มีการรับประกันความเสถียร ไม่มีอายุการใช้งานที่กำหนด และสามารถเปลี่ยนแปลงหรือเลิกใช้งานได้โดยแจ้งให้ทราบล่วงหน้า 30 วัน
การเปลี่ยนแปลงของเวอร์ชัน
- การเพิ่มเวอร์ชันหลัก (เช่น จาก v1 เป็น v2): การเพิ่มเวอร์ชันหลักแสดงถึงการเปลี่ยนแปลงที่เข้ากันไม่ได้แบบย้อนหลังและส่งผลกับส่วนอื่นในระบบ ซึ่งต้องให้นักพัฒนาแอปดำเนินการ เฉพาะการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบของ API ย่อยที่เสถียรเท่านั้นที่จะมีหมายเลขเวอร์ชันใหม่ เช่น จาก v1 เป็น v2
- การเปลี่ยนแปลงเล็กน้อย: การเพิ่มหรือการแก้ไขที่เข้ากันได้แบบย้อนหลังจะแสดงเป็นการเปลี่ยนแปลงในเวอร์ชันหลักที่มีอยู่ การเปลี่ยนแปลงดังกล่าวจะมีรายละเอียดอยู่ในบันทึกประจำรุ่นของเวอร์ชันหลักนั้น การเพิ่มที่ไม่ส่งผลกับส่วนอื่นในระบบใน API ย่อยจะเผยแพร่ไปยังช่องอัลฟ่าของเวอร์ชันเสถียรล่าสุดหรือไปยังเวอร์ชันเสถียรล่าสุดโดยตรง
นโยบายการเลิกใช้งาน
เราจะเลิกใช้งาน Merchant API ย่อยเวอร์ชันเก่าเป็นระยะๆ เราให้คำมั่นสัญญาว่าจะให้ระยะเวลาการเลิกใช้งาน 12 เดือนสำหรับเวอร์ชันหลักที่เสถียร (vX) โดยเริ่มนับจากประกาศการเลิกใช้งานอย่างเป็นทางการ
ตัวอย่างเช่น หากเราเลิกใช้งาน v1 ของ API ย่อย Products ในวันที่ 15 มกราคม 2026 ระบบจะเลิกใช้งาน API ย่อยดังกล่าวไม่เร็วกว่าวันที่ 15 มกราคม 2027 หลังจากวันที่นี้ คุณจะใช้ API ย่อยเวอร์ชันก่อนหน้าไม่ได้อีกต่อไป
สถานะเวอร์ชันและวงจรการใช้งานของ API ย่อย
ตารางต่อไปนี้แสดงเวอร์ชันล่าสุดของ API ย่อยแต่ละรายการของ Merchant API
| API ย่อย | เวอร์ชัน | สถานะ |
|---|---|---|
| บัญชี | v1 v1alpha v1beta |
ใช้งานอยู่ ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| Conversion | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| แหล่งข้อมูล | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| Inventories | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| การแก้ไขปัญหา | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| พาร์ทเนอร์ทางธุรกิจสำหรับฟีดในร้าน | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| การแจ้งเตือน | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| การติดตามคำสั่งซื้อ | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| ผลิตภัณฑ์ | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| Product Studio | v1alpha | ใช้งานอยู่ |
| โปรโมชัน | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| Quota | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| รายงาน | v1 v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
| รีวิว | v1alpha v1beta |
ใช้งานอยู่ เลิกใช้งานแล้วเมื่อวันที่ 28 ก.พ. 2026 |
แนวทางปฏิบัติแนะนำ
- ตรวจสอบบันทึกประจำรุ่นและการอัปเดตล่าสุด เป็นประจำเพื่อดูเวอร์ชันใหม่ การอัปเดตหลัก การปรับปรุง และประกาศเกี่ยวกับการ เปิดตัวและการเลิกใช้งาน API ย่อย
- หาก API ย่อยมีเวอร์ชันเสถียร 2 เวอร์ชันขึ้นไป เราขอแนะนำให้ใช้เวอร์ชันล่าสุดอยู่เสมอ
- ออกแบบแอปพลิเคชันให้จัดการข้อผิดพลาดต่างๆ ของ API ย่อยได้อย่างราบรื่น ซึ่งรวมถึงปัญหาเครือข่าย ขีดจำกัดอัตรา และรหัสหรือข้อความแสดงข้อผิดพลาดใหม่ที่อาจมีการนำมาใช้ใน API ย่อยเวอร์ชันใหม่
- อย่ารอจนกว่าเวอร์ชัน API ย่อยจะเลิกใช้งานแล้วจึงเริ่มวางแผนการอัปเกรด เริ่มประเมินและทดสอบเวอร์ชันใหม่ทันทีที่พร้อมใช้งาน
- หากมีคำขอฟีเจอร์หรือข้อกังวลเกี่ยวกับแผนงาน API ย่อย โปรดติดต่อเรา พร้อมคำถามหรือความคิดเห็น ดูข้อมูลเกี่ยวกับวิธีติดต่อทีม Merchant API เพื่อขอรับการสนับสนุนด้านเทคนิคได้ที่ รับความช่วยเหลือเกี่ยวกับ Merchant API