ניהול גרסאות

גרסת ה-Partner API מצוינת בכתובת ה-URL. הגרסה הנוכחית היא:

https://partner-api.performancehub.co/partner/v1/

מדיניות שינויים

Performance Hub שואף לבצע שינויים מצטברים ותואמים לאחור בכל מקום אפשרי.

דוגמאות לשינויים תואמים לאחור:

הוספת שדה אופציונלי חדש לבקשה.
הוספת שדה חדש לתגובה.
הוספת נקודת קצה חדשה.
הוספת ערך enum חדש, במקרים שבהם הלקוחות אמורים לטפל בערכים לא מוכרים.
שיפור הודעות האימות בלי לשנות את חוזה קודי הסטטוס.

access_time_windows ו-access_time_windows_revision הם שדות שנוספו לבקשת Member. לקוחות קיימים שמשמיטים אותם שומרים על תמונת המצב השמורה של Access Time Windows ללא שינוי. כלל ההשמטה הזה שומר על תאימות ל-upsert חלקי; השמטה אינה שקולה לשליחת מערך ריק.

דוגמאות לשינויים שוברי תאימות:

הסרה או שינוי שם של שדה.
שינוי הסוג של שדה.
הפיכת שדה בקשה אופציונלי לשדה חובה.
הסרת נקודת קצה.
שינוי המשמעות של קוד סטטוס קיים או של reason ייעודי לתחום.

הוצאה משימוש

כשנדרש שינוי שובר תאימות, Performance Hub יימנע ככל האפשר משינוי הגרסה הקיימת במקומה. במקום זאת, נציג גרסה חדשה או נתיב העברה, ונודיע על השינוי לשותפים המושפעים.

הודעות על הוצאה משימוש יכולות לכלול:

רשומה ביומן השינויים.
תקשורת ישירה עם השותפים.
הערות ב-Partner Console.
הנחיות העברה בתיעוד.

המלצות ללקוחות

בנו לקוחות שעמידים בפני שינויים מצטברים:

התעלמו משדות תגובה שאינכם משתמשים בהם.
התייחסו לערכי enum לא מוכרים כלא נתמכים, במקום לקרוס.
הימנעו מבדיקות שוויון קפדניות של התגובה.
תעדו ביומן ערכים לא מזוהים, כדי שתוכלו לעדכן את האינטגרציה שלכם באופן מכוון.

במחיצות עם גרסאות של Member, כגון Access Time Windows, שמרו את הגרסה שנשלחה ואת המטען המנורמל עד שהתוצאה ידועה. שימוש חוזר בגרסה עבור תוכן שהשתנה הוא התנגשות, ואילו שליחה חוזרת של אותו תוכן היא אידמפוטנטית. ראו Access Time Windows.

מפרטי OpenAPI

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

ראו מפרטי OpenAPI.