از اینجا شروع کنید
نسخه‌بندی و منسوخ‌سازی
با نسخه‌های اصلی در URL، افزوده‌های سازگار، اعلان‌های منسوخ‌سازی و بازه‌های پایان پشتیبانی آشنا شوید.
مسیرهای پایدار نسخه اصلی
یکپارچه‌سازی‌های مشتری از یک نسخه اصلی در URL استفاده می‌کنند که در حال حاضر /api/v1 است. info.version تاریخ‌محور در OpenAPI قرارداد منتشرشده دقیق را درون آن نسخه اصلی مشخص می‌کند.
تغییرات سازگار
SendHQ ممکن است درون v1 فیلدهای اختیاری درخواست، فیلدهای پاسخ، مقادیر enum (در جایی که schema اجازه می‌دهد) و عملیات جدید اضافه کند. کلاینت‌ها باید فیلدهای ناشناخته پاسخ را نادیده بگیرند و یک enum را برای همیشه بسته فرض نکنند، مگر اینکه schema چنین بگوید.
تغییرات ناسازگار
تغییر ناسازگار در درخواست، پاسخ، احراز هویت یا رفتار به یک مسیر نسخه اصلی جدید مانند /api/v2، مستندات مهاجرت و یک دوره انتقال اعلام‌شده نیاز دارد. API فعلی v1 منسوخ نشده است.
منسوخ‌سازی و پایان پشتیبانی
وقتی نسخه‌ای منسوخ می‌شود، SendHQ جایگزین و مسیر مهاجرت را مستند می‌کند و در موارد مربوط، هدرهای Deprecation و Sunset را برمی‌گرداند. نسخه‌های منسوخ‌شده دست‌کم تا 90 روز پس از تاریخ منسوخ‌سازی اعلام‌شده در دسترس می‌مانند، مگر اینکه ادامه کار آن‌ها ریسک فوری امنیتی یا حقوقی ایجاد کند.