RemoteGymp · API v1

מגבלות ושגיאות

קרא כל עמוד, כבד את מגבלות הקצב והתאושש בבטחה משגיאות.

  1. מגבלות קצב

    ניתן להגדיר את המגבלות. GET /v1/operations/capabilities מדווח על requestsPerMinute ו-authenticationRequestsPerMinutePerIp. לאחר 429, כבד את Retry-After והמתן זמן רב יותר אם הוויסות נמשך. קריאות אצווה מקבלות עד 100 מזהים; נקודות קצה בודדות עשויות להיות בעלות מגבלות עמוד או מטען קטנות יותר.

  2. תקרא כל עמוד

    השתמש בכלל ההמשך עבור נקודת הקצה שאליה קראת, תוך שמירה על אותם מסננים. רשימות יכולות להשתנות בזמן הקריאה; השתמש בתמונות כאשר אתה זקוק לעותק עקבי.

    עמודיםהמשך עםעצור כאשר
    סמןהעביר את next כ-after.הבא בתור הוא null.
    היסט עם nextOffsetהעביר את nextOffset כ-offset.nextOffset הוא null.
    קיזוז עם hasMoreהגדל את הקיזוז במספר הפריטים המוחזרים.hasMore הוא false.
    תוכנההעבירו את הערך המספרי next כ-after; הפעילו מחדש אם updatedAtUtc משתנה.הבא בתור הוא null.
    הזנת אירועיםהעביר את next כ-after.hasMore הוא false.
  3. טיפול בשגיאות

    קראו את קוד השגיאה וכן את סטטוס ה-HTTP. אם התגובה כוללת את requestId, צטטו אותו בעת פנייה לתמיכה.

    סטטוס HTTPמה לעשות
    400תקן את הבקשה.
    401בדוק את האישורים או קבל אסימון גישה חדש.
    403בדוק את ההיקף, ההרשאות והאם הגישה מופעלת.
    404ייתכן שהמשאב חסר או מחוץ לתחום שלך.
    409קרא את קוד השגיאה ואת המצב הנוכחי לפני קבלת החלטה.
    410תמונת המצב או סמן האירוע פג תוקפו. התחל בסיס חדש.
  4. אם כתיבה נגמרת

    פסק זמן או 503 אינם מוכיחים שהפעולה נכשלה. עבור כתיבות המחזירות קבלות פעולה, חפש את GET /v1/operations/by-key?idempotencyKey={key} לפני ניסיון חוזר. ליצירת תחזוקה, השתמש שוב ב-Idempotency-Key ובגוף המקוריים.

התייחסות ל-API →

תיקון תוכן 3f225a253 · OpenAPI SHA-256: b12c42306a89