RemoteGymp · API v1

Gränser och fel

Läs varje sida, respektera hastighetsgränser och återställ säkert från fel.

  1. Hastighetsgränser

    Gränserna är konfigurerbara. GET /v1/operations/capabilities rapporterar requestsPerMinute och authenticationRequestsPerMinutePerIp. Efter en 429, respektera Återförsök-Efter och vänta längre om strypningen fortsätter. Batchläsningar accepterar upp till 100 ID:n; enskilda slutpunkter kan ha mindre sid- eller nyttolastgränser. (Retry-After)

  2. Läs varje sida

    Använd fortsättningsregeln för den slutpunkt du anropade, och behåll samma filter. Listor kan ändras medan du läser dem; använd ögonblicksbilder när du behöver en konsekvent kopia.

    SidningsnumreringFortsätt medStoppa när
    MarkörSkicka next som after.nästa är null.
    Förskjutning med nextOffsetSkicka nextOffset som offset.nextOffset är null.
    Offset med hasMoreÖka offset med antalet returnerade artiklar.hasMore är falskt.
    ProgramvaraSkicka det numeriska next-värdet som after; starta om om updatedAtUtc ändras.nästa är null.
    HändelseflödeSkicka next som after.hasMore är falskt.
  3. Hantera fel

    Läs felkoden samt HTTP-statusen. Om svaret inkluderar requestId, ange den när du kontaktar supporten.

    HTTP-statusVad du ska göra
    400Åtgärda begäran.
    401Kontrollera inloggningsuppgifter eller hämta en ny åtkomsttoken.
    403Kontrollera omfattning, behörigheter och om åtkomst är aktiverad.
    404Resursen kan saknas eller vara utanför ditt omfång.
    409Läs felkoden och det aktuella tillståndet innan du fattar beslut.
    410Snapshot- eller händelsemarkören har upphört att gälla. Starta en ny baslinje.
  4. Om en skrivning får timeout

    En timeout eller 503 bevisar inte att åtgärden misslyckades. För skrivningar som returnerar operationskvitton, sök upp GET /v1/operations/by-key?idempotencyKey={key} innan du försöker igen. För underhållsskapande, återanvänd originalet Idempotency-Key och brödtexten.

API-referens →

Innehållsrevision 3f225a253 · OpenAPI SHA-256: b12c42306a89