نسخه سازی

این راهنما توضیح می‌دهد که Merchant API چگونه نسخه‌سازی، انتشار و چرخه عمر نسخه‌های مختلف خود را مدیریت می‌کند.

طرح نسخه سازی

Merchant API از یک استراتژی نسخه‌سازی در سطح API فرعی استفاده می‌کند. این بدان معنی است که هر API، به عنوان مثال محصولات در API Merchant، چرخه حیات نسخه خود را خواهد داشت.

فرمت نسخه سازی و ارائه

• نسخه های پایدار زیر API: اگر یک زیر API در یک نسخه پایدار باشد، تمام روش های آن در یک نسخه پایدار هستند. یک نسخه sub-API پایدار به صورت vX نمایش داده می شود (به عنوان مثال، v1 ، v2 ). اینها نسخه های اصلی آماده تولید هستند.

• نسخه های زیر API آلفا: اگر یک زیر API در یک آلفا باشد، تمام روش های آن در آلفا هستند. یک نسخه alpha sub-API به صورت vXalpha نمایش داده می شود (به عنوان مثال، v1alpha ، v2alpha ). آنها حاوی ویژگی های تجربی و دسترسی اولیه هستند که برای آزمایش و تکرار سریع در نظر گرفته شده است. نسخه‌های آلفا بدون تضمین پایداری ارائه می‌شوند، طول عمر مشخصی ندارند و می‌توان آن‌ها را با یک دوره اعلان 30 روزه تغییر داد یا متوقف کرد.

نسخه تغییر می کند

• افزایش‌های نسخه اصلی (مثلاً v1 تا v2): این تغییرات ناسازگار با عقب و شکستن را نشان می‌دهد که نیاز به اقدام توسعه‌دهنده دارد. فقط شکستن تغییرات APIهای فرعی پایدار دارای شماره نسخه جدید خواهد بود. به عنوان مثال، v1 تا v2.

• تغییرات جزئی: اضافات یا اصلاحات سازگار با عقب به عنوان تغییرات در نسخه اصلی موجود ارائه می شوند. چنین تغییراتی در یادداشت‌های انتشار آن نسخه اصلی به تفصیل بیان خواهد شد. افزودنی‌های بدون شکست به یک API فرعی در کانال آلفا آخرین نسخه پایدار یا مستقیماً به آخرین نسخه پایدار منتشر می‌شوند.

سیاست غروب آفتاب

ما به صورت دوره‌ای نسخه‌های قدیمی‌تر زیرمجموعه Merchant را غروب می‌کنیم. ما متعهد به یک پنجره 12 ماهه انحلال برای نسخه‌های اصلی پایدار (vX) هستیم که از زمان اعلام رسمی منسوخ شدن شروع می‌شود.

به‌عنوان مثال، اگر نسخه 1 از API فرعی محصولات را در 15 ژانویه 2026 منسوخ کنیم، زودتر از 15 ژانویه 2027 غروب نمی‌کند. پس از این تاریخ، نسخه قبلی زیر API دیگر برای استفاده در دسترس نخواهد بود.

نسخه زیر API و وضعیت چرخه عمر

جدول زیر آخرین نسخه‌های هر زیر API Merchant API را فهرست می‌کند:

بهترین شیوه ها

• به طور منظم یادداشت‌های انتشار و آخرین به‌روزرسانی‌ها را برای نسخه‌های جدید، به‌روزرسانی‌های اصلی، بهبودها، و اطلاعیه‌های مربوط به راه‌اندازی و لغو APIهای فرعی بررسی کنید.
• اگر یک API فرعی دو یا چند نسخه پایدار دارد، پیشنهاد می کنیم همیشه از آخرین نسخه استفاده کنید.
• برنامه خود را طوری طراحی کنید که به‌خوبی خطاهای زیر API، از جمله مشکلات شبکه، محدودیت‌های نرخ، و کدهای خطا یا پیام‌هایی را که ممکن است با نسخه‌های زیر API جدیدتر معرفی شوند، مدیریت کند.
• منتظر نمانید تا یک نسخه API فرعی در حال غروب آفتاب باشد تا برنامه ریزی ارتقای خود را شروع کنید. ارزیابی و آزمایش نسخه های جدید را به محض در دسترس بودن شروع کنید.
• برای درخواست های ویژگی یا نگرانی در مورد نقشه راه زیر API، با سؤال یا بازخورد با ما تماس بگیرید . برای اطلاعات در مورد نحوه تماس با تیم Merchant API برای پشتیبانی فنی، به دریافت راهنمایی درباره Merchant API مراجعه کنید.