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

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

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

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

เช่น หากเราเลิกใช้งาน v1 ของ Products Sub-API ในวันที่ 15 มกราคม 2026 เราจะหยุดให้บริการในวันที่ 15 มกราคม 2027 เป็นอย่างเร็ว หลังจากวันที่ดังกล่าว คุณจะใช้ sub-API เวอร์ชันก่อนหน้าไม่ได้อีกต่อไป

เวอร์ชันย่อยของ API และสถานะวงจรการใช้งาน

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

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

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