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

คู่มือนี้จะอธิบายวิธีที่ Merchant API จัดการการกำหนดเวอร์ชัน การเผยแพร่ และวงจรของเวอร์ชันต่างๆ

รูปแบบการกำหนดเวอร์ชัน

Merchant API ใช้กลยุทธ์การกำหนดเวอร์ชันที่ระดับ API ย่อย ซึ่งหมายความว่า Merchant API แต่ละรายการ เช่น Products ภายใน Merchant API จะมีวงจรเวอร์ชันของตัวเอง

รูปแบบและการนำเสนอการกำหนดเวอร์ชัน

• เวอร์ชัน API ย่อยที่เสถียร: หาก API ย่อยอยู่ในเวอร์ชันเสถียร เมธอดทั้งหมดของ API ย่อยนั้นจะอยู่ในเวอร์ชันเสถียร เวอร์ชัน API ย่อยที่เสถียรจะแสดงเป็น vX (เช่น v1, v2) ซึ่งเป็นเวอร์ชันหลักที่พร้อมใช้งานจริง

• เวอร์ชัน API ย่อยแบบอัลฟ่า: หาก API ย่อยอยู่ในเวอร์ชันอัลฟ่า เมธอดทั้งหมดของ API ย่อยนั้นจะอยู่ในเวอร์ชันอัลฟ่าด้วย เวอร์ชัน API ย่อยแบบอัลฟ่าจะแสดงเป็น vXalpha (เช่น v1alpha, v2alpha) โดยมีฟีเจอร์ทดลองใช้ก่อนเปิดตัวซึ่งมีไว้สำหรับการทดสอบและการทำซ้ำอย่างรวดเร็ว เวอร์ชันอัลฟ่าไม่มีการรับประกันความเสถียร ไม่มีอายุการใช้งานที่กำหนด และสามารถเปลี่ยนแปลงหรือปิดให้บริการได้โดยมีระยะเวลาแจ้งให้ทราบ 30 วัน

การเปลี่ยนแปลงของเวอร์ชัน

• การเพิ่มเวอร์ชันหลัก (เช่น v1 เป็น v2): การเพิ่มเวอร์ชันหลักจะบ่งบอกถึงการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบและมีความไม่เข้ากันแบบย้อนหลัง ซึ่งนักพัฒนาแอปต้องดำเนินการ เฉพาะการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบของ API ย่อยที่เสถียรเท่านั้นที่จะมีหมายเลขเวอร์ชันใหม่ เช่น v1 เป็น v2
• การเปลี่ยนแปลงเล็กน้อย: การเพิ่มหรือการแก้ไขที่เข้ากันได้แบบย้อนหลังจะแสดงเป็นการเปลี่ยนแปลงในเวอร์ชันหลักที่มีอยู่ การเปลี่ยนแปลงดังกล่าวจะระบุไว้ในบันทึกประจำรุ่นของเวอร์ชันหลักนั้นๆ การเพิ่ม API ย่อยที่ไม่มีผลกระทบต่อการทำงานจะเปิดตัวในเวอร์ชันอัลฟ่าของเวอร์ชันเสถียรล่าสุดหรือเปิดตัวในเวอร์ชันเสถียรล่าสุดโดยตรง

นโยบายการสิ้นสุดการสนับสนุน

เราจะหยุดให้บริการ Merchant sub-API เวอร์ชันเก่าเป็นระยะๆ เรามุ่งมั่นที่จะให้ระยะเวลาการเลิกใช้งาน 12 เดือนสำหรับเวอร์ชันหลักที่เสถียร (vX) โดยเริ่มจากประกาศการเลิกใช้งานอย่างเป็นทางการ

ตัวอย่างเช่น หากเราเลิกใช้งาน API ย่อยของผลิตภัณฑ์เวอร์ชัน 1 ในวันที่ 15 มกราคม 2026 ระบบจะหยุดให้บริการ API ดังกล่าวตั้งแต่วันที่ 15 มกราคม 2027 เป็นต้นไป หลังจากวันที่นี้ API ย่อยเวอร์ชันก่อนหน้าจะใช้งานไม่ได้อีกต่อไป

เวอร์ชัน Sub-API และสถานะวงจร

ตารางต่อไปนี้แสดงเวอร์ชันล่าสุดของ API ย่อยแต่ละรายการของ Merchant API

API ย่อย	เวอร์ชัน	สถานะ
บัญชี	v1 v1alpha	ใช้งานอยู่ ใช้งานอยู่
Conversion	v1	ใช้งานอยู่
แหล่งข้อมูล	v1	ใช้งานอยู่
สินค้าคงคลัง	v1	ใช้งานอยู่
การแก้ไขปัญหา	v1	ใช้งานอยู่
พาร์ทเนอร์ทางธุรกิจสำหรับฟีดในร้าน	v1	ใช้งานอยู่
การแจ้งเตือน	v1	ใช้งานอยู่
การติดตามคำสั่งซื้อ	v1	ใช้งานอยู่
ผลิตภัณฑ์	v1	ใช้งานอยู่
Product Studio	v1alpha	ใช้งานอยู่
โปรโมชัน	v1	ใช้งานอยู่
โควต้า	v1	ใช้งานอยู่
รายงาน	v1	ใช้งานอยู่
รีวิว	v1alpha	ใช้งานอยู่

แนวทางปฏิบัติแนะนำ

• ตรวจสอบบันทึกประจำรุ่นและข้อมูลอัปเดตล่าสุดเป็นประจำเพื่อดูเวอร์ชันใหม่ การอัปเดตหลัก การปรับปรุง และประกาศเกี่ยวกับการเปิดตัวและการเลิกใช้งาน API ย่อย
• หาก API ย่อยมีเวอร์ชันเสถียรตั้งแต่ 2 เวอร์ชันขึ้นไป เราขอแนะนำให้ใช้เวอร์ชันล่าสุดเสมอ
• ออกแบบแอปพลิเคชันให้จัดการข้อผิดพลาดต่างๆ ของ API ย่อยได้อย่างราบรื่น ซึ่งรวมถึงปัญหาเกี่ยวกับเครือข่าย การจำกัดอัตราคำขอ และรหัสข้อผิดพลาดหรือข้อความแสดงข้อผิดพลาดใหม่ที่อาจมาพร้อมกับ API ย่อยเวอร์ชันใหม่ๆ
• อย่ารอจนกว่า API ย่อยเวอร์ชันหนึ่งๆ กำลังจะหยุดให้บริการจึงค่อยเริ่มวางแผนการอัปเกรด เริ่มประเมินและทดสอบเวอร์ชันใหม่ทันทีที่พร้อมใช้งาน
• หากมีคำขอฟีเจอร์หรือข้อกังวลเกี่ยวกับแผนกลยุทธ์ของ API ย่อย โปรดติดต่อเราเพื่อส่งคำถามหรือความคิดเห็น ดูข้อมูลเกี่ยวกับวิธีติดต่อทีม Merchant API เพื่อรับการสนับสนุนด้านเทคนิคได้ที่รับความช่วยเหลือเกี่ยวกับ Merchant API