เวอร์ชัน API

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

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

การอัปเกรดเวอร์ชันในโหมดทดสอบและโหมดใช้งานจริงจะทำแยกกันทีละครั้ง

การเรียกใช้งาน 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 ได้จากบนแดชบอร์ดเลย เพื่อให้การใช้งาน API ในครั้งต่อๆ ไปดำเนินการผ่านเวอร์ชัน 2015-11-17 โดยอัตโนมัติ

ตัวอย่าง Header:

Omise-Version: 2015-11-17

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