תיעוד API

מדריך העברת API — שדרוג בין גרסאות

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

פורסם ב-21 במרץ 2026 • 16 דקות קריאה • מתקדם

סקירת העברה

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

עקרונות מפתח להעברה:

  • גרסה סמנטית — פורמט MAJOR.MINOR.PATCH מיושם בקפדנות
  • תמיכה ארוכת טווח — גרסה מרכזית קודמת נתמכת למשך 24+ חודשים
  • אזהרות הפסקת שימוש — הודעה מוקדמת של 6 חודשים על כל שינוי מפריע
  • גרסאות מקבילות — הפעל v1 ו-v2 במקביל במהלך ההעברה
  • בדיקות אוטומטיות — כלי תאימות לסדרת בדיקות מסופקים

סטטוס נוכחי: v1 (נוכחי), v2 (בטא, זמינות כללית Q2 2026). v1 נתמך עד Q1 2028.

מדיניות גרסאות

גרסה סמנטית

פורמט גרסה
גרסת API: MAJOR.MINOR.PATCH
דוגמה: 2.1.3
MAJOR (2) - שינויים מפריעים, ארכיטקטורה חדשה
MINOR (1) - תכונות תואמות לאחור
PATCH (3) - תיקוני באגים, עדכוני אבטחה

מחזור שחרור גרסה

שלב משך מאפיינים
אלפא 2-4 שבועות שינויים מפריעים רבים, לבדיקות בלבד
בטא 4-8 שבועות יציב ברובו, משוב מהקהילה
מועמד לשחרור 2-4 שבועות מוכן להפקה, ליטוש סופי
זמינות כללית 24+ חודשים תמיכת הפקה מלאה
קבל את מפתח ה-API שלך תוך 30 שניות

מוכן לבנות? קבל מפתח API חינם (100 קריאות/יום, ללא כרטיס) והתחל למשוך נתוני ליווייתנים, מימון ונתוני שרשרת חיים.

קבל את מפתח ה-API שלך →

תאימות לאחור

תאימות גרסאות

בתוך גרסה מרכזית, תוכל תמיד לשדרג לגרסאות משנה/תיקון חדשות בבטחה:

  • כתובות נקודות קצה — נשארות ללא שינוי
  • שדות נדרשים — לעולם לא מוסרים (רק שדות אופציונליים חדשים מתווספים)
  • קודי סטטוס HTTP — נשמרים עבור תרחישים קיימים
  • מבנה תגובה — שדות ליבה נשארים זהים
  • אימות — אין שינויים במנגנוני האימות

הפסקת שימוש הדרגתית

ציר זמן להפסקת שימוש
// חודש 1: הכרזת הפסקת שימוש
// תכונה מסומנת בכותרת Deprecation
Deprecation: version="2.2", sunset="2026-09-01"
// חודש 3-6: תקופת הפסקת שימוש פעילה
// ה-API מחזיר אזהרות אך עדיין עובד
X-Deprecation-Warning: נקודת קצה זו תוסר ב-2026-09-01
// חודש 6: הסרה סופית
// נקודת קצה מחזירה 410 Gone
HTTP/1.1 410 Gone

העברה מ-V1 ל-V2

שינויים מרכזיים

  • עיצוב מחדש של REST API — נקודות קצה למשאבים נקיות יותר
  • פורמט תגובה — עטיפה עקבית, טיפול טוב יותר בשגיאות
  • אימות — הוספת תמיכה ב-OAuth 2.0 (מפתחות API עדיין עובדים)
  • הגבלת קצב — שיפור בגרגריות ובהירות
  • Webhooks — עיצוב מחדש של פורמט אירוע וחתימה

מיפוי נקודות קצה

נקודת קצה V1 נקודת קצה V2 שינויים
GET /whales GET /v2/whales/tracking אורגן מחדש, הוספת סינון
GET /funding GET /v2/derivatives/funding-heatmap פרמטר Exchange נדרש
GET /positions GET /v2/derivatives/positions אפשרויות צבירה חדשות

שינויים בנקודות הקצה

שינויים בפרמטרי בקשה

בקשה V1
// V1: שערי מימון
GET /v1/funding?symbol=BTCUSDT&exchange=binance
בקשה V2
// V2: אותם נתונים, מבנה ברור יותר
GET /v2/derivatives/funding-heatmap?
symbol=BTCUSDT&
exchange=binance

עדכוני מבנה תגובה

מבנה תגובה V1

פורמט V1
{
"status": "success",
"data": {
"symbol": "BTCUSDT",
"funding": 0.0001
}
}

מבנה תגובה V2

פורמט V2
{
"data": {
"symbol": "BTCUSDT",
"funding_rate": 0.0001
},
"_meta": {
"request_id": "req_abc123",
"timestamp": 1709980800000
}
}

הבדלים עיקריים: ללא עטיפת סטטוס, שדות ברורים יותר, מטא-דטה סטנדרטית.

ציר זמן להפסקת שימוש

הפסקות שימוש מתוכננות

תכונה הוכרז תאריך סיום תחליף
/v1/whales Jan 2026 Jan 2028 /v2/whales/tracking
/v1/funding Jan 2026 Jan 2028 /v2/derivatives/funding-heatmap
אימות באמצעות מפתח API בלבד Mar 2026 Mar 2027 OAuth 2.0 (מפתחות עדיין עובדים)
פורמט Webhook v1 Q2 2026 Q2 2027 פורמט Webhook v2

פירוט שוברים שינויים

נקודות קצה שהוסרו

  • /v1/stats — הוחלף על ידי /v2/metrics
  • /v1/historical — הוחלף על ידי /v2/historical עם פרמטרים חדשים
  • /v1/alerts/create — הוחלף על ידי POST /v2/alerts

שינויים בפרמטרים

  • limit — ברירת המחדל השתנתה מ-100 ל-20 (היה מפורש!)
  • timeframe — כעת נדרש לשאילתות היסטוריות
  • sort — הפורמט השתנה מ-"field asc" ל-"field:asc"

שינויים בשדות תגובה

  • funding → funding_rate
  • price → mark_price
  • vol → volume_quote

מיגור צעד אחר צעד

שלב 1: תכנון (שבוע 1-2)

  1. בדיקת אינטגרציה קיימת עבור תכונות שהופסקו
  2. מיפוי נקודות קצה v1 למקבילות ב-v2
  3. זיהוי שינויים שוברים המשפיעים על הקוד שלך
  4. תכנון אסטרטגיית בדיקה וציר זמן

שלב 2: פיתוח (שבוע 3-4)

  1. יצירת ענף v2 בבקרת גרסאות
  2. עדכון כל נקודות הקצה של ה-API לכתובות v2
  3. עדכון טיפול בבקשות/תגובות
  4. הרצת בדיקות יחידה נגד סביבת sandbox

שלב 3: בדיקה (שבוע 5-6)

  1. הרצת סדרת בדיקות אינטגרציה מלאה
  2. בדיקת תרחישי שגיאות ומקרי קצה
  3. בדיקת עומס עם נקודות קצה v2
  4. בדיקת אבטחה של הקוד המעודכן

שלב 4: העברה לשלב (שבוע 7)

  1. הטמעת קוד v2 בסביבת staging
  2. הרצת בדיקות קבלה מלאות
  3. קבלת אישור ממחזיקי עניין
  4. הכנת תוכנית גיבוי

שלב 5: הפקה (שבוע 8)

  1. הטמעה כחול-ירוק לייצור
  2. ניטור מדדים ושיעורי שגיאות
  3. הישאר בכוננות לבעיות תמיכה
  4. הפסקה הדרגתית של קוד v1

תמיכה ומשאבים

כלים זמינים

  • מאמת מיגור — בדיקת קוד לשימוש שהופסק
  • בודק שדרוג API — השוואת תאימות בין v1 ו-v2
  • רשימת בדיקות למיגור — קובץ PDF עם משימות וציר זמן
  • דוגמאות קוד — דוגמאות לפני ואחרי מיגור

קבלת עזרה

  • אימייל: [email protected]
  • תיעוד: ראה changelog-versioning.html
  • Discord: ערוץ תמיכה קהילתי
  • Enterprise: מהנדס מיגור ייעודי

התחל את המיגור שלך היום

שדרג ל-API v2 עם כלי מיגור מקיפים, תיעוד ותמיכה. נבנה לתמיכה במיגור ללא זמן השבתה.

גלה V2
V1 נתמך עד Jan 2028. תכנן את המיגור שלך היום.

משאבים קשורים

יומן שינויים וגרסאות →

היסטוריית גרסאות מפורטת

הפניה ל-REST API →

תיעוד API V2

מדריך בדיקה →

סביבת sandbox לבדיקה
התחלה בחינם — 100 קריאות/יום, ללא כרטיס

קבל נתוני זרימת לווייתנים, מימון, עניין פתוח ונתוני on-chain מ-3 בורסות מ-API אחד. רמה חינמית, ללא כרטיס אשראי, שדרג בכל עת.

התחל בחינם →
נסה את קונסולת ה-API החיה → (לא נדרש חשבון)