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 – це хибність.
    Програмне забезпеченняПередати числове значення next як after; перезапустити, якщо updatedAtUtc зміниться.наступний - null.
    Стрічка подійПередати next як after.hasMore – це хибність.
  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