צעדים ראשונים

שגיאות

כשמשהו משתבש, ה-API מחזיר את סטטוס ה-HTTP המתאים וגוף תגובה עם code ו-message בתוך error.

בקוד שלך יש להשתמש ב-code. השדה message הוא טקסט באנגלית שנועד לעזור למי שמנפה באגים, והוא עשוי להשתנות.

פורמט השגיאה404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

ללא מפתח401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

קודי שגיאה

סטטוס	קוד	מתי זה קורה
400	`key_in_query`	המפתח נשלח בכתובת ה-URL (בפרמטרים `api_key`, `apikey`, `key` או `token`). יש לשלוח אותו בכותרת וליצור מפתח חדש, כי ייתכן שהמפתח הקודם נשמר ביומנים.
400	`invalid_parameter`	לאחד הפרמטרים יש ערך לא תקין, למשל `per_page` מעל המקסימום.
401	`missing_api_key`	הבקשה לא כללה מפתח.
401	`invalid_api_key`	המפתח לא קיים, תוקפו בוטל או שהמשתמש שלו הושבת.
404	`not_found`	נקודת הקצה לא קיימת, או שהפריט לא קיים או שייך לארגון שהמשתמש לא יכול לראות.
404	`organization_not_found`	ה-`organization` שצוין אינו ארגון שבו המשתמש יכול לראות פריטים מהסוג הזה.
405	`method_not_allowed`	ה-API מקבל רק `GET` (ו-`HEAD`).
429	`rate_limited`	מגבלת הבקשות מוצתה. יש להמתין את מספר השניות שמופיע ב-`Retry-After`.
500	`server_error`	שגיאה פנימית. יש לנסות שוב בעוד רגע; אם הבעיה נמשכת, ניתן לפנות לתמיכה.

כדאי לחזור על אותה בקשה רק אחרי 429 (בהמתנה לזמן שמופיע ב-Retry-After) או אחרי 500. שגיאות אחרות מחייבות תיקון בבקשה או במפתח.