Skip to main content
כל תגובת שגיאה של /v1 היא application/problem+json ‏(RFC 9457) עם קבוצת שדות קבועה:
יש לבצע הסתעפות לוגית על סמך code ולא על סמך detail — code הוא חוזה יציב לקריאה אוטומטית; detail מיועד לקריאה אנושית ועשוי להשתנות. param מופיע כאשר ניתן לייחס את השגיאה לפרמטר מסוים בבקשה. יש לצרף את request_id בעת פנייה לתמיכה.

קודי שגיאה

קבוצת הקודים סגורה: הוספת קודים חדשים היא שינוי בחוזה הציבורי ותוכרז באמצעות יומן השינויים של ה-API. תגובת retryable: true מציינת שייתכן שהמצב ייפתר מעצמו; היא אינה מוכיחה שפעולת כתיבה לא הייתה בעלת השפעה. יש לנסות שוב פעולות קריאה במסגרת תקציב מוגבל של ניסיונות וזמן, תוך שימוש בהשהיה מעריכית (exponential backoff) וב-jitter. יש לכבד את Retry-After כאשר הוא קיים, לרבות בתגובת 409 או 429 שניתן לנסות שוב. בפעולות שינוי, יש לפעול בהתאם לחוזה האידמפוטנטיות וההתאוששות המתועד של הפעולה. יש לשמור את המפתח המקורי ואת הבקשה המקורית כאשר הדבר נתמך. אין ליצור מפתח חדש לאחר פקיעת זמן או 5xx: פעולה זו עלולה לחזור על כתיבה שהצליחה. כותרת Idempotency-Key אינה מספקת הגנה בפעולה שאינה תומכת בה.