Ограничения

Обновлено: 09.05.2024

Лимиты частоты запросов (Rate Limiting)Лимиты частоты запросов (Rate Limiting)

Интеграционное API ограничивает количество запросов с одного пользователя и IP-адреса.

Если лимит превышен, сервер возвращает ошибку:

429 Too Many Requests

Лимиты могут изменяться динамически. Базовые правила следующие:

• не более 500 запросов за 10 секунд на одного пользователя;
• не более 5 одинаковых GET-запросов за 60 секунд на одного пользователя.

Рекомендации по обработке ошибок при вызове APIРекомендации по обработке ошибок при вызове API

Вызов API может завершиться с ошибкой. Основные категории ошибок:

• транзитные ошибки (transient errors) — временные сбои, например, сетевые проблемы или кратковременная недоступность сервиса;
• ошибки ограничения частоты запросов — например, HTTP 429 Too Many Requests.

Для продуктовых сред (production) рекомендуется использовать стратегию повторных попыток (Retry Policy).

Рекомендуемый алгоритмРекомендуемый алгоритм

1. Выполните вызов API.

2. Если произошла транзитная ошибка или ошибка 429, выполните повторную попытку.

3. Используйте экспоненциальную задержку (exponential backoff) между попытками.
   Пример последовательности задержек: 100 мс → 500 мс → 1500 мс → 5000 мс.

4. Ограничьте максимальное количество повторных попыток, чтобы избежать бесконечных циклов.

5. Организуйте мониторинг и логирование:

   • сам факт повторной попытки не является ошибкой, но должен фиксироваться как диагностический сигнал;
   • если после всех попыток вызов завершился неуспешно, это считается ошибкой. Требуется анализ и, при необходимости, корректировка архитектуры (например, пересмотр SLA, таймаутов или стратегии взаимодействия с API).

Лимит на размер страницы данныхЛимит на размер страницы данных

Один запрос возвращает не более 500 сущностей (объектов).

Для постраничной загрузки данных используйте параметры запроса $skip и $top. Чтобы избежать дублирования данных на разных страницах, обязательно применяйте сортировку, например, по полю id.

Если в ответе содержится максимальное количество элементов, в теле ответа OData будет присутствовать свойство nextLink с URL для получения следующей страницы данных.

Ограничение на вычислительную нагрузкуОграничение на вычислительную нагрузку

Важно! Каждому абоненту выделяется ограниченный объём вычислительных ресурсов. Чрезмерная нагрузка на API может снизить производительность для других пользователей вашей организации. В таких случаях система мониторинга может автоматически ограничить доступ к API с IP-адреса, вызвавшего нагрузку.

Рекомендации по использованиюРекомендации по использованию

1. Не используйте API как локальную базу данных или службу с неограниченными ресурсами.
2. Продумывайте архитектуру интеграции. Используйте встроенные возможности: свойства created и modified для фильтрации по времени, серверную фильтрацию и группировку данных.
3. Помните о назначении API. Интеграционное API не предназначено для выгрузки больших объёмов данных. Для этих целей используйте Reporting API.