نسخه‌بندی API

نسخه Major در URL قرارداد عمومی قرار می‌گیرد:

https://service.smsdaily.ir/v1/...

سیاست نسخه‌بندی

• تغییرات backward-compatible بدون تغییر Major منتشر می‌شوند.
• Breaking Change در نسخه Major جدید مانند /v2 ارائه می‌شود.
• نسخه قدیمی قبل از حذف وارد دوره Deprecation می‌شود.
• تاریخ Deprecation و Sunset در Changelog و در صورت نیاز Headerهای پاسخ اعلام می‌شود.
• مستندات هر نسخه باید مستقل و قابل ارجاع باقی بماند.
• فیلدهای جدید ممکن است در پاسخ‌های یک Major اضافه شوند؛ Client نباید با مشاهده فیلد ناشناخته Fail شود.
• معنی فیلد یا مقدار موجود به‌صورت ناسازگار تغییر نمی‌کند؛ در صورت نیاز Contract جدید منتشر می‌شود.

قرارداد فعلی v1 در مرحله 1.0.0-rc.3 است. RC3 قابلیت Webhook/Callback و SDK رسمی .NET را بدون تغییر مسیرهای موجود اضافه می‌کند. پس از اعلام Production، Breaking Change فقط در Major جدید انجام خواهد شد.