Установка и настройка
В этом разделе мы поможем вам настроить окружение для работы с Deps API и начать использовать все его возможности.
Заголовки запросов
Для всех запросов к API необходимо указывать следующие заголовки:
Заголовок | Обязательный | Описание |
---|---|---|
X-API-Key | Да | Ваш API-ключ |
Accept | Нет | application/json |
Лимиты
Deps API использует систему ограничения частоты запросов для обеспечения стабильной работы сервиса для всех пользователей.
Тип ключа | Интервал в секундах | Запросов в минуту |
---|---|---|
Стандартный | 10 | 6 |
Корпоративный | Договорной | Договорной |
При превышении лимита API возвращает код состояния 429 Too Many Requests
и заголовок Retry-After
, указывающий количество секунд до момента, когда можно будет сделать следующий запрос.
Deps API использует систему ограничения частоты запросов для обеспечения стабильной работы сервиса для всех пользователей.
Тип ключа | Интервал в секундах | Запросов в минуту |
---|---|---|
Стандартный | 10 | 6 |
Корпоративный | Договорной | Договорной |
При превышении лимита API возвращает код состояния 429 Too Many Requests
и заголовок Retry-After
, указывающий количество секунд до момента, когда можно будет сделать следующий запрос.
При возникновении ошибки API возвращает соответствующий HTTP-код и объект JSON с детальной информацией:
Поле error_id
можно использовать при обращении в техподдержку для быстрого выявления проблемы.
Рекомендуемые настройки клиента
Настройка таймаутов
Рекомендуется устанавливать следующие таймауты для HTTP-клиента:
- Таймаут соединения: 5 секунд
- Таймаут ожидания ответа: 30 секунд
Реализация повторных попыток
Для повышения надежности вашего приложения рекомендуется реализовать механизм повторных попыток с экспоненциальной задержкой для кодов ошибок 5xx и 429:
Мониторинг и логирование
Для эффективного отслеживания использования API рекомендуется внедрить логирование всех запросов и ответов в вашем приложении. Это поможет диагностировать проблемы и оптимизировать использование API.
Кэширование
Для оптимизации производительности и снижения количества запросов рекомендуется кэшировать ответы API, особенно для данных, которые меняются редко: