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