API เวอร์ชัน

เรามีการอัพเดต API อยู่เสมอ ซึ่งโดยส่วนใหญ่แล้วอัพเดตเหล่านี้จะไม่กระทบต่อการใช้งานใดๆ ของระบบเดิม การอัพเดตจึงเกิดขึ้นโดยอัตโนมัติ

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

การอัพเดตเวอร์ชันใน test mode และ live mode จะทำแยกกันทีละครั้ง

การเรียกใช้งาน API สามารถเลือกเวอร์ชันที่ต้องการใช้ได้ โดยให้ใส่ Omise-Version header ลงใน http request ระบบจะเลือกดำเนินการตามเวอร์ชันที่ระบุใน header แทนระบบที่ติดตั้งไว้กับบัญชีของคุณ เมื่อทำแบบนี้คุณสามารถทดลองใช้ API เวอร์ชันใหม่ได้โดยไม่จำเป็นต้องอัพเดตทั้งระบบ และยังมั่นใจได้ว่าการใช้วิธีนี้จะไม่มีช่วงเวลา downtime ขณะทำการ deploy เลย

สมมุติว่ากำลังใช้งาน API เวอร์ชัน 2014-07-27 คุณสามารถอัพเดตไปใช้เวอร์ชัน 2015-11-17 ได้โดย:

  • อัพเดตโค้ดเพื่อให้รองรับ API เวอร์ชันใหม่ (ในตัวอย่างเป็นการแก้ไขชื่อ attribute ใน charge จาก captured เป็น paid)
  • ใส่ Omise-Version: 2015-11-17 header ลงใน http request เพื่อให้โค้ดใหม่ของคุณใช้งาน API เวอร์ชันใหม่
  • เมื่อทำการ deploy แล้ว สามารถอัพเดตเวอร์ชัน API ได้จากบน dashboard ของคุณ เพื่อให้การใช้งาน API ในครั้งต่อๆ ไปดำเนินการผ่านเวอร์ชัน 2015-11-17 โดยอัตโนมัติ

ตัวอย่าง Header:

Omise-Version: 2015-11-17

เวอร์ชัน API ทั้งหมด