این راهنما توضیح می‌دهد که چگونه Merchant API نسخه‌بندی، انتشارها و چرخه عمر نسخه‌های مختلف خود را مدیریت می‌کند.
طرح نسخه‌بندی
رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) از یک استراتژی نسخه‌بندی در سطح زیر-رابطه (sub-API) استفاده می‌کند. این بدان معناست که هر رابط برنامه‌نویسی کاربردی (API)، برای مثال محصولات درون رابط برنامه‌نویسی کاربردی فروشنده، چرخه حیات نسخه مخصوص به خود را خواهد داشت.
قالب و ارائه نسخه‌بندی
نسخه‌های پایدار زیر-API: اگر یک زیر-API در نسخه پایدار باشد، تمام متدهای آن در نسخه پایدار هستند. یک نسخه پایدار زیر-API به صورت vX نمایش داده می‌شود (برای مثال، v1 ، v2 ). اینها نسخه‌های اصلی آماده برای تولید هستند.
نسخه‌های آلفای زیر-API: اگر یک زیر-API در نسخه آلفا باشد، تمام متدهای آن در نسخه آلفا هستند. یک نسخه آلفای زیر-API به صورت vXalpha (برای مثال، v1alpha ، v2alpha ) نمایش داده می‌شود. آنها شامل ویژگی‌های آزمایشی و دسترسی زودهنگام هستند که برای آزمایش و تکرار سریع در نظر گرفته شده‌اند. نسخه‌های آلفا بدون تضمین پایداری ارائه می‌شوند، طول عمر مشخصی ندارند و می‌توانند با یک دوره اطلاع‌رسانی 30 روزه تغییر کنند یا متوقف شوند.
تغییرات نسخه
افزایش نسخه‌های اصلی (برای مثال، از نسخه ۱ به نسخه ۲): این موارد نشان‌دهنده ناسازگاری با نسخه‌های قبلی و تغییرات در حال تغییر هستند که نیاز به اقدام توسعه‌دهنده دارند. فقط تغییرات در حال تغییر در زیر-APIهای پایدار، شماره نسخه جدید خواهند داشت. برای مثال، از نسخه ۱ به نسخه ۲.
تغییرات جزئی: اضافات یا اصلاحات سازگار با نسخه‌های قبلی به عنوان تغییرات در نسخه اصلی موجود ارائه می‌شوند. چنین تغییراتی در یادداشت‌های انتشار برای آن نسخه اصلی به تفصیل شرح داده خواهد شد. اضافات غیرقابل تغییر به یک زیر-API در کانال آلفای آخرین نسخه پایدار یا مستقیماً در آخرین نسخه پایدار منتشر می‌شوند.
سیاست غروب آفتاب
ما به صورت دوره‌ای نسخه‌های قدیمی‌تر زیر-API فروشگاه را حذف می‌کنیم. ما به یک بازه زمانی ۱۲ ماهه برای نسخه‌های اصلی پایدار (vX) متعهد می‌شویم که از زمان اعلام رسمی منسوخ شدن، شروع می‌شود.
برای مثال، اگر نسخه ۱ از زیر-API محصولات را در ۱۵ ژانویه ۲۰۲۶ منسوخ کنیم، این نسخه زودتر از ۱۵ ژانویه ۲۰۲۷ منسوخ نخواهد شد. پس از این تاریخ، نسخه قبلی زیر-API دیگر برای استفاده در دسترس نخواهد بود.
نسخه زیر-API و وضعیت چرخه حیات
جدول زیر آخرین نسخه‌های هر زیر-API از Merchant API را فهرست می‌کند:
| زیر-API | نسخه‌ها | وضعیت |
|---|---|---|
| حساب‌ها | نسخه ۱ وی۱آلفا وی۱بتا | فعال فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| تبدیل‌ها | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| منابع داده | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| موجودی‌ها | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| حل مسئله | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| مشارکت فیدهای محلی | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| اعلان‌ها | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| پیگیری سفارش | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| محصولات | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| استودیوی محصول | وی۱آلفا | فعال |
| تبلیغات | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| سهمیه | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| گزارش‌ها | نسخه ۱ وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
| نقد و بررسی‌ها | وی۱آلفا وی۱بتا | فعال در تاریخ ۲۸ فوریه ۲۰۲۶ متوقف خواهد شد |
بهترین شیوه‌ها
- مرتباً یادداشت‌های انتشار و آخرین به‌روزرسانی‌ها را برای نسخه‌های جدید، به‌روزرسانی‌های اصلی، بهبودها و اطلاعیه‌های مربوط به راه‌اندازی و منسوخ شدن زیر-APIها بررسی کنید.
- اگر یک زیر-API دو یا چند نسخه پایدار دارد، پیشنهاد می‌کنیم همیشه از آخرین نسخه استفاده کنید.
- برنامه خود را طوری طراحی کنید که به راحتی خطاهای مختلف sub-API، از جمله مشکلات شبکه، محدودیت‌های سرعت و کدهای خطای جدید یا پیام‌هایی که ممکن است با نسخه‌های جدیدتر sub-API معرفی شوند را مدیریت کند.
- منتظر نمانید تا نسخه فرعی API شما به پایان عمر خود برسد و سپس برای ارتقاء آن برنامه‌ریزی کنید. به محض اینکه نسخه‌های جدید در دسترس قرار گرفتند، ارزیابی و آزمایش آنها را آغاز کنید.
- برای درخواست ویژگی یا نگرانی در مورد نقشه راه زیر API، با ما تماس بگیرید و سوالات یا بازخورد خود را با ما در میان بگذارید . برای کسب اطلاعات در مورد نحوه تماس با تیم Merchant API برای پشتیبانی فنی، به بخش «دریافت کمک با Merchant API» مراجعه کنید.