ניהול גרסאות

במדריך הזה נסביר איך Merchant API מטפל בגרסאות, במהדורות ובמחזור החיים של הגרסאות השונות שלו.

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

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

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

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

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

שינויים בגרסה

• עליות גרסה ראשיות (לדוגמה, v1 ל-v2): אלה סימנים לשינויים שאינם תואמים לאחור ולשינויים משמעותיים שדורשים פעולה מצד המפתחים. רק לשינויים משמעותיים בממשקי API משניים יציגו מספר גרסה חדש. לדוגמה, מ-v1 ל-v2.

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

שקיעה

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

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

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

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

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

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