سیاست نسخه بندی و منسوخ سازی API سرویکس

نسخه عمومی فعلی API: /api/v1. این صفحه مرجع چرخه عمر برای اتصال مشتریان است.

مالک سیاست: تیم محصول API سرویکس. آخرین بازبینی انسانی: ۲۹ ژوئیه ۲۰۲۶. این سیاست حداقل هر شش ماه و پس از هر تصمیم مهم چرخه عمر بازبینی می شود.

تغییر سازگار در v1

وقتی درخواست یا پردازش پاسخ اتصال موجود بدون تغییر ادامه پیدا کند، Servix می تواند تغییر additive را در /api/v1 اعمال کند. endpoint جدید، property اختیاری جدید، enum مستند جدید در قراردادی که مدیریت مقدار ناشناخته را لازم می داند و اصلاحی که رفتار را به قرارداد مستند برمی گرداند از این گروه هستند.

کلاینت باید property اختیاری ناشناخته را نادیده بگیرد، نوع مستند را اعتبارسنجی کند و ترتیب propertyهای پاسخ را قرارداد نداند.

تغییر breaking چیست؟

تغییر path درخواست، نام property پاسخ یا نوع مستند property تغییر breaking است. حذف endpoint یا property لازم، تغییر الزام احراز هویت یا تغییر معنای تثبیت شده status code نیز وقتی اتصال سازگار موجود را مجبور به تغییر کد کند breaking محسوب می شود.

تغییر breaking که به شکل سازگار قابل ارائه نیست از مسیر major جدید API منتشر می شود. معمولا چند تغییر breaking مرتبط در یک major version گروه بندی می شوند، اما حتی یک تغییر کوچک نیز اگر سازگاری حفظ نشود می تواند major جدید لازم داشته باشد. فقط تعداد تغییرها معیار تصمیم نیست.

اعلان deprecation

Servix پیش از کنار گذاشتن نسخه، path، property یا رفتار پشتیبانی شده حداقل ۹۰ روز تقویمی اطلاع می دهد. اعلان، قرارداد تحت تاثیر، جایگزین یا مسیر migration، تاریخ برنامه ریزی شده توقف و مسیر پشتیبانی را مشخص می کند.

مشتریان دارای اشتراک پولی فعال اعلان را با ایمیل و notification پنل مشتری دریافت می کنند. همان اعلان در changelog عمومی منتشر می شود و اگر روی دسترس پذیری اثر داشته باشد از صفحه وضعیت سرویس نیز لینک می شود.

استثناهای فوری

اگر مشکل امنیتی فوری، الزام قانونی یا تغییر خارج از کنترل تامین کننده ادامه سازگاری را ناامن، غیرقانونی یا ناممکن کند، مهلت ۹۰ روزه می تواند کوتاه شود. Servix دلیل، اثر بر مشتری و راه کاهش اثر را در اولین زمان عملی از همان کانال های عمومی، ایمیل و پنل مشتری اعلام می کند.

این سیاست SLA نیست

این صفحه رویه عملیاتی مورد انتظار Servix را توضیح می دهد و توافق سطح خدمت قراردادی نیست. برای تغییر جاری changelog، برای اثر فعال وضعیت سرویس و برای سوابق ۳۰ روز اخیر رخدادها را ببینید. پرسش اتصال را در بخش پشتیبانی حساب یا صفحه تماس مطرح کنید.