RemoteGymp · API v1

Rajoitukset ja virheet

Lue jokainen sivu, noudata nopeusrajoituksia ja palauta virheet turvallisesti.

  1. Nopeusrajoitukset

    Rajoitukset ovat konfiguroitavissa. GET /v1/operations/capabilities raportoi requestsPerMinute:n ja authenticationRequestsPerMinutePerIp:n. 429-virheen jälkeen noudata uudelleenyritystä ja odota kauemmin, jos rajoitus jatkuu. Eräluennot hyväksyvät jopa 100 tunnusta; yksittäisillä päätepisteillä voi olla pienempiä sivu- tai hyötykuormarajoituksia. (Retry-After)

  2. Lue jokainen sivu

    Käytä kutsumallesi päätepisteelle samaa jatkuvuussääntöä ja säilytä samat suodattimet. Listat voivat muuttua niitä luettaessa; käytä tilannevedoksia, kun tarvitset yhtenäisen kopion.

    SivutusJatka:Pysäytä, kun:
    KohdistinOhita next:n arvona after.Seuraavaksi tulee null.
    Siirry nextOffset:n arvonaOhita nextOffset:n arvona offset.nextOffset on null.
    Offset hasMore:n kanssaLisää offsetia palautettujen kohteiden lukumäärällä.hasMore on epätosi.
    OhjelmistoVälitä numeerinen next-arvo muodossa after; käynnistä uudelleen, jos updatedAtUtc muuttuu.Seuraavaksi tulee null.
    TapahtumasyöteOhita next:n arvona after.hasMore on epätosi.
  3. Virheiden käsittely

    Lue virhekoodi sekä HTTP-tila. Jos vastaus sisältää requestId:n, mainitse se ottaessasi yhteyttä tukeen.

    HTTP-tilaToimenpiteet
    400Korjaa pyyntö.
    401Tarkista tunnistetiedot tai hanki uusi käyttöoikeustunnus.
    403Tarkista laajuus, käyttöoikeudet ja onko käyttöoikeus käytössä.
    404Resurssi saattaa puuttua tai olla käyttöalueesi ulkopuolella.
    409Lue virhekoodi ja nykyinen tila ennen päätöksentekoa.
    410Pikavedos tai tapahtumakursori vanheni. Aloita uusi perusviiva.
  4. Jos kirjoitus aikakatkaistaan

    Aikakatkaisu tai 503 ei todista toiminnon epäonnistumista. Jos kirjoituksessa on kuitteja, jotka palauttavat toimintokuittauksia, etsi GET /v1/operations/by-key?idempotencyKey={key} ennen uudelleenyritystä. Ylläpidon luonnissa käytä alkuperäistä Idempotency-Key-tiedostoa ja sen runkoa uudelleen.

API-viite →

Sisällön versio 3f225a253 · OpenAPI SHA-256: b12c42306a89