ניהול גרסאות

במדריך הזה מוסבר איך מתבצעים ב-Merchant API ניהול הגרסאות, ההשקות ומחזור החיים של הגרסאות השונות.

סכמת ניהול גרסאות

ב-Merchant API יש אסטרטגיית ניהול גרסאות ברמת ה-API המשני. כלומר, לכל Merchant API, למשל Products ב-Merchant API, יהיה מחזור חיים משלו לגרסה.

הפורמט והתצוגה של ניהול הגרסאות

• גרסאות יציבות של ממשקי API משניים: אם ממשק API משני הוא בגרסה יציבה, כל השיטות שלו הן בגרסה יציבה. גרסה יציבה של sub-API מיוצגת על ידי vX (לדוגמה, v1,‏ v2). אלה גרסאות עיקריות שמוכנות לייצור.

• גרסאות אלפא של ממשקי API משניים: אם ממשק API משני נמצא בשלב אלפא, כל ה-methods שלו נמצאות בשלב אלפא. גרסת אלפא של תת-API מיוצגת כ-vXalpha (לדוגמה, v1alpha,‏ v2alpha). הם מכילים תכונות ניסיוניות בגישה מוקדמת, שמיועדות לבדיקה ולפיתוח מהיר. גרסאות אלפא לא כוללות הבטחה ליציבות, אין להן משך חיים מוגדר ואפשר לשנות או להפסיק אותן בהתראה של 30 יום מראש.

שינויים בגרסאות

• שינויים בגרסאות הראשיות (לדוגמה, מגרסה 1 לגרסה 2): השינויים האלה לא תואמים לדורות קודמים ועלולים לגרום לכשלים, ולכן המפתחים צריכים לבצע פעולות. רק שינויי תוכנה שעלולים לגרום לכשל בממשקי API משניים יציבים יקבלו מספר גרסה חדש. לדוגמה, מגרסה 1 לגרסה 2.
• שינויים קלים: תוספות או תיקונים שתואמים לדורות קודמים מוצגים כשינויים בגרסה הראשית הקיימת. השינויים האלה יפורטו בנתוני הגרסה של הגרסה הראשית הרלוונטית. תוספות שלא גורמות לשיבושים ב-API משני יופצו בערוץ האלפא של הגרסה היציבה האחרונה או ישירות לגרסה היציבה האחרונה.

מדיניות ההוצאה משימוש

מדי פעם אנחנו מוציאים משימוש גרסאות ישנות יותר של Merchant sub-API. אנחנו מתחייבים לחלון זמן של 12 חודשים להוצאה משימוש של גרסאות ראשיות יציבות (vX), החל מההודעה הרשמית על ההוצאה משימוש.

לדוגמה, אם נוציא משימוש את גרסה 1 של Products sub-API ב-15 בינואר 2026, היא תושבת ב-15 בינואר 2027 או לאחר מכן. אחרי התאריך הזה, הגרסה הקודמת של ה-sub-API לא תהיה זמינה יותר לשימוש.

גרסת ה-API המשני וסטטוס מחזור החיים

בטבלה הבאה מפורטות הגרסאות העדכניות של כל ממשק API משני של Merchant API:

Sub-API	גרסאות	סטטוס
חשבונות	v1 v1alpha	פעיל פעיל
המרות	v1	פעילה
מקורות נתונים	v1	פעילה
מלאי שטחי פרסום	v1	פעילה
פתרון בעיות	v1	פעילה
ספק ניהול פידים של חנויות מקומיות	v1	פעילה
התראות	v1	פעילה
מעקב אחר משלוחים	v1	פעילה
מוצרים	v1	פעילה
Product Studio	v1alpha	פעילה
קידומי מכירות	v1	פעילה
מכסה	v1	פעילה
דוחות	v1	פעילה
ביקורות	v1alpha	פעילה

שיטות מומלצות

• כדאי לבדוק באופן קבוע את הערות הגרסה ואת העדכונים האחרונים כדי לראות גרסאות חדשות, עדכונים משמעותיים, שיפורים והודעות על השקות והוצאות משימוש של ממשקי API משניים.
• אם ל-API משני יש שתי גרסאות יציבות או יותר, מומלץ להשתמש תמיד בגרסה העדכנית ביותר.
• חשוב לתכנן את האפליקציה כך שתטפל בצורה חלקה בשגיאות שונות של ממשקי API משניים, כולל בעיות ברשת, הגבלת קצב של יצירת בקשות, וקודי שגיאה או הודעות שגיאה חדשים שעשויים להופיע בגרסאות חדשות יותר של ממשקי API משניים.
• אל תחכו עד שגרסת ה-API המשני תצא משימוש כדי להתחיל לתכנן את השדרוג. כדאי להתחיל להעריך ולבדוק גרסאות חדשות ברגע שהן זמינות.
• אם אתם רוצים להגיש בקשה להוספת תכונה או שיש לכם שאלות לגבי מפת הדרכים של ממשק API משני, פנו אלינו. איך פונים לצוות Merchant API לקבלת תמיכה טכנית