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

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

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

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

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

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

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

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

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

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

พระอาทิตย์ตก

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

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

เวอร์ชันและสถานะวงจรชีวิตของ API ย่อย

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

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

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

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