דילוג לתוכן
אומת

קודי שגיאה

כל קוד שלילי וסטטוס HTTP בקטלוג השגיאות של CPI, מה הוא אומר ומה לעשות.

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

שגיאות סטטוס HTTP

אלה הסטטוסים שרואים בשכבת התעבורה, בין אם פונים ישירות לדף ובין אם קוראים ל-cpi.

קודי חוזה הלקוח

הלקוח של הדשבורד עצמו מזהה את הקודים האלה ומפעיל לפיהם זרימת ממשק ספציפית במקום הודעת שגיאה כללית. החיוב עבר מיתרה בתשלום מראש לחיוב בדיעבד, ולכן השערים היחידים שנותרו על פעולה בתשלום הם כרטיס חסר וחשבונית שעבר מועד פירעונה. הקודים -92 (יתרה שלילית) ו--93 (נדרשת טעינה) הוסרו משער החשבון שהיה זורק אותם; מטפל ב--93 עדיין קיים בלקוח לצורכי תאימות, פשוט אין לו מה שיפעיל אותו.

מעטפת התשובה

כל שיטה, בהצלחה או בכישלון, עונה { code, data }. code >= 1 הוא הצלחה; code < 0 הוא שגיאה. חלק משגיאות שכבת ה-HTTP מוסיפות מפתח מחרוזת error לצד code המספרי ("rate_limited", "invalid_fields", "appeal_failed"), לפעמים עם מערך fields: [].

CPI ממפה code שלילי לסטטוס HTTP בכלל אחד: קוד מ--400 עד -499 הופך לסטטוס המדויק הזה (-400 עצמו עונה HTTP 400, -404 עונה HTTP 404, -409 עונה HTTP 409, -428 עונה HTTP 428). כל קוד שלילי אחר, -1, -500, -762, -999, כל דבר מחוץ לטווח הזה, עונה גם הוא HTTP 400 פשוט. מספר נקודות קצה נפרדות וצרות יותר (כמה נתיבי קופה בחנות וטפסים ציבוריים, לא השליחה הכללית /cpi/<method>) ממפות רק -404/-403/-400 ומשתמשות ב-422 כברירת מחדל לכל השאר; המפה הזו מקומית לנתיבים האלה ואינה מתארת את הכלל הכללי שלמעלה, ולכן -400 מהשליחה הכללית הוא HTTP 400, לא 422.

אותו מספר משמש בשיטות שונות עם משמעויות שונות, במיוחד -1 ו--400. תמיד כדאי לקרוא את הודעת data ולבדוק איזו שיטה נקראה; המשמעויות להלן הן המקרה הנפוץ, לא הבטחה.

קודים שליליים של CPI

הקודים ששווה לפצל לפיהם לוגיקה, שנאספו מסריקה של כל cpi/*_module.

מעבר לטבלה הזו, מודולים בודדים משתמשים בקודים שליליים קטנים (בערך -2 עד -25, -44/-45/-46, -64 עד -78, -99/-101/-106) למצבי ביניים ייחודיים למודול. כמעט תמיד הם מלווים בהודעת data תיאורית, לרוב err.message. כשנתקלים באחד מהם, קוראים את מחרוזת data ואת השיטה שהחזירה אותו ולא מסתמכים על המספר לבדו.

שגיאות פנימיות או לא מוצהרות

מספר כשלים אף פעם לא מגיעים למעטפת { code, data }: חריגה שלא נתפסה, דחיית הבטחה שלא טופלה, throw new Error(...) שמופיע כ-401 או 500 חשופים (למשל 'app is off', 'Account suspended', 'Account terminated'), או כשל של ברוקר ההודעות. את אלה מזהים לפי צורה או מקור ולא לפי קוד קבוע, וכדאי תמיד להסלים אותם ולא לנסות שוב בעיוורון.