קודי שגיאה

הבן תגובות שגיאה של ה-API וכיצד לטפל בהן.

סקירה כללית

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

פורמט תגובת שגיאה

כל תגובות השגיאה עוקבות אחר המבנה הזה:

{
  "status": "error",
  "error": {
    "code": "AUTH_1001",
    "message": "אישורי אימות חסרים",
    "details": "שדות 'username' ו-'password' שניהם נדרשים",
    "timestamp": "2025-12-22T10:30:00Z"
  }
}
שדהסוגתיאור
statusstringתמיד "error" לתגובות שגיאה
error.codestringמזהה ייחודי לשגיאה
error.messagestringהודעת שגיאה קריאה
error.detailsstringהקשר נוסף (אופציונלי)
error.timestampstringחותמת זמן ISO 8601

שגיאות אימות (1000-1099)

שגיאות הקשורות לאישורים ואימות.

קודHTTPהודעהפתרון
AUTH_1001 401 אישורי אימות חסרים כלול שם משתמש וסיסמה בבקשה
AUTH_1002 401 שם משתמש או סיסמה לא חוקיים ודא שהאישורים נכונים
AUTH_1003 403 חשבון נעול זמנית המתן לפני ניסיון חוזר או צור קשר עם התמיכה

שגיאות מכסה (1100-1199)

שגיאות הקשורות למכסת API ומגבלות שימוש.

קודHTTPהודעהפתרון
QUOTA_1101 403 מכסת API לא מספיקה רכוש קרדיטים נוספים או בדוק מכסה
QUOTA_1102 429 מכסת API חרגה המתן לחידוש המכסה או שדרג את התוכנית שלך

שגיאות אימות (2000-2099)

שגיאות הקשורות לאימות בקשה ונתוני קלט.

קודHTTPהודעהפתרון
VAL_2001 400 לא הועלה קובץ כלול קובץ בבקשה
VAL_2002 400 פורמט קובץ לא חוקי השתמש בפורמטים נתמכים: PDF, PNG, JPG, WEBP
VAL_2003 400 מספר קבצי PDF אינם מותרים העלה PDF אחד או מספר תמונות
VAL_2004 400 לא ניתן לערבב PDF ותמונות העלה או PDF או תמונות, לא שניהם
VAL_2005 400 קוד שפה לא נתמך השתמש בקוד שפה נתמך

שגיאות עיבוד (3000-3099)

שגיאות במהלך עיבוד מסמך וניתוח AI.

קודHTTPהודעהפתרון
PROC_3001 500 עיבוד מסמך נכשל בדוק את איכות התמונה, נסה שוב את הבקשה
PROC_3002 500 חילוץ מטא-נתונים נכשל ודא שהמסמך מכיל טקסט קריא
PROC_3003 500 חילוץ פרמטרים נכשל ודא שפורמט בדיקת הדם ניתן לזיהוי
PROC_3004 500 יצירת פרשנות נכשלה נסה שוב את הבקשה
PROC_3006 504 חרגת זמן עיבוד הקטן את גודל הקובץ או פצל למספר בקשות
PROC_3007 500 ניתוח נכשל לאחר מספר ניסיונות המתן ונסה שוב, או צור קשר עם התמיכה

שגיאות שרת (5000-5099)

שגיאות שרת פנימיות ובעיות זמינות שירות.

קודHTTPהודעהפתרון
SRV_5001 500 שגיאת שרת פנימית נסה שוב את הבקשה, צור קשר עם התמיכה אם הבעיה נמשכת
SRV_5002 503 שירות לא זמין זמנית המתן ונסה שוב עם backoff אקספוננציאלי

שיטות עבודה מומלצות לטיפול בשגיאות

המלצות
  1. תמיד בדוק את שדה status - תגובות מוצלחות יש להן "status": "success"
  2. הטמע לוגיקת ניסיון חוזר לשגיאות זמניות (5xx) עם backoff אקספוננציאלי
  3. רשום קודי שגיאה לצורך ניפוי באגים וניטור
  4. הצג הודעות ידידותיות למשתמש המבוססות על קודי שגיאה
  5. השתמש בנקודות קצה sandbox כדי לבדוק טיפול בשגיאות

דוגמה לטיפול בשגיאות (JavaScript)

async function analyzeBloodTest(file) {
  try {
    const response = await fetch(API_URL, {
      method: 'POST',
      body: formData
    });

    const data = await response.json();

    if (data.status === 'error') {
      const errorCode = data.error.code;

      switch (true) {
        case errorCode.startsWith('AUTH_'):
          throw new Error('אימות נכשל. בדוק את האישורים שלך.');
        case errorCode.startsWith('QUOTA_'):
          throw new Error('המכסה חרגה. אנא שדרג את התוכנית שלך.');
        case errorCode.startsWith('VAL_'):
          throw new Error('בקשה לא חוקית: ' + data.error.message);
        case errorCode.startsWith('PROC_'):
          // נסה שוב לשגיאות עיבוד
          return retryRequest(file);
        default:
          throw new Error('אירעה שגיאה. אנא נסה שוב.');
      }
    }

    return data.data;
  } catch (error) {
    console.error('שגיאת API:', error);
    throw error;
  }
}