เริ่มต้นที่นี่
การกำหนดเวอร์ชันและการเลิกใช้
ทำความเข้าใจเวอร์ชันหลักใน URL การเพิ่มที่เข้ากันได้ ประกาศการเลิกใช้ และช่วง sunset
พาธเวอร์ชันหลักที่เสถียร
การเชื่อมต่อของลูกค้าใช้เวอร์ชันหลักใน URL ปัจจุบันคือ /api/v1 ค่า info.version ของ OpenAPI ที่อิงวันที่ระบุสัญญาที่เผยแพร่อย่างตรงตัวภายในเวอร์ชันหลักนั้น
การเปลี่ยนแปลงที่เข้ากันได้
SendHQ อาจเพิ่มฟิลด์คำขอที่ไม่บังคับ ฟิลด์การตอบกลับ ค่า enum ในกรณีที่สคีมาอนุญาต และการดำเนินการใหม่ภายใน v1 ไคลเอนต์ควรเพิกเฉยต่อฟิลด์การตอบกลับที่ไม่รู้จัก และอย่าถือว่า enum ปิดตายถาวรเว้นแต่สคีมาระบุ
การเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้
การเปลี่ยนแปลงคำขอ การตอบกลับ การยืนยันตัวตน หรือพฤติกรรมที่ทำให้ใช้งานไม่ได้ ต้องใช้พาธเวอร์ชันหลักใหม่ เช่น /api/v2 เอกสารการย้าย และการเปลี่ยนผ่านที่ประกาศไว้ API v1 ปัจจุบันไม่ได้ถูกเลิกใช้
การเลิกใช้และ sunset
เมื่อเวอร์ชันถูกเลิกใช้ SendHQ จะบันทึกเอกสารตัวแทนและเส้นทางการย้าย และคืนเฮดเดอร์ Deprecation และ Sunset ในกรณีที่ใช้ได้ เวอร์ชันที่เลิกใช้ยังคงใช้ได้อย่างน้อย 90 วันหลังวันที่ประกาศเลิกใช้ เว้นแต่การเปิดต่อจะสร้างความเสี่ยงด้านความปลอดภัยหรือกฎหมายที่เร่งด่วน