RemoteGymp · API v1

Limity a chyby

Přečtěte každou stránku, dodržujte limity rychlosti a bezpečně se zotavte z chyb.

  1. Limity rychlosti

    Limity jsou konfigurovatelné. GET /v1/operations/capabilities hlásí requestsPerMinute a authenticationRequestsPerMinutePerIp. Po chybě 429 respektujte Retry-After a čekejte déle, pokud omezování pokračuje. Dávkové čtení akceptuje až 100 ID; jednotlivé koncové body mohou mít menší limity stránek nebo datového zatížení.

  2. Přečtěte si každou stránku

    Použijte pravidlo pokračování pro volaný koncový bod a zachujte stejné filtry. Seznamy se mohou během čtení měnit; snímky použijte, když potřebujete konzistentní kopii.

    StránkováníPokračovat sZastavit, když
    KurzorPředat next jako after.další je null.
    Posunout s nextOffsetPředat nextOffset jako offset.nextOffset je null.
    Offset s hasMoreZvětšit offset o počet vrácených položek.hasMore je false.
    SoftwarePředat číselnou hodnotu next jako after; restartovat, pokud se updatedAtUtc změní.další je null.
    Kanál událostíPředat next jako after.hasMore je false.
  3. Ošetření chyb

    Přečíst chybový kód a stav HTTP. Pokud odpověď obsahuje requestId, uveďte ji při kontaktování podpory.

    Stav HTTPCo dělat
    400Opravte požadavek.
    401Zkontrolujte přihlašovací údaje nebo získejte nový přístupový token.
    403Zkontrolujte rozsah, oprávnění a zda je přístup povolen.
    404Prostředek může chybět nebo je mimo váš rozsah.
    409Před rozhodnutím si přečtěte kód chyby a aktuální stav.
    410Platnost snímku nebo kurzoru události vypršela. Spusťte novou základní linii.
  4. Pokud vyprší časový limit zápisu

    Časový limit nebo chyba 503 nedokazuje, že akce selhala. U zápisů, které vracejí potvrzení operace, vyhledejte před opětovným pokusem GET /v1/operations/by-key?idempotencyKey={key}. Pro vytváření údržby znovu použijte původní Idempotency-Key a tělo.

Referenční příručka API →

Revize obsahu 3f225a253 · OpenAPI SHA-256: b12c42306a89