Начало работы
Аутентификация
Deps API использует систему аутентификации на основе API-ключей для обеспечения безопасного доступа к ресурсам. Все запросы к API должны включать действительный API-ключ.
Авторизация API-ключом
Каждый запрос к Deps API должен включать ваш API-ключ в заголовке X-API-Key
.
Пример запроса
Пример ответа при отсутствии или недействительном ключе
Безопасность
Защита API-ключа
Ваш API-ключ должен храниться в безопасном месте и не должен быть доступен публично. Рекомендуется:
- Не включать API-ключи в исходный код, доступный в публичных репозиториях
- Использовать переменные окружения или системы управления секретами
- Регулярно проверять использование ключа для выявления подозрительной активности
Ротация ключей
Регулярная смена API-ключей является хорошей практикой безопасности. Для ротации ключей:
- Создайте новый API-ключ в панели управления
- Обновите ваше приложение для использования нового ключа
- После успешного перехода отзовите старый ключ
Типы аутентификации
Стандартная аутентификация
Для большинства сценариев использования достаточно стандартной аутентификации с использованием заголовка X-API-Key
.
Ошибки аутентификации
Код ошибки | HTTP-код | Описание |
---|---|---|
UNAUTHORIZED | 401 | Отсутствует или недействительный API-ключ |
RATE_LIMIT_EXCEEDED | 429 | Превышен лимит запросов для API-ключа |
Рекомендации по разработке
Централизованное управление аутентификацией
Вместо добавления API-ключа к каждому запросу вручную, рекомендуется создать централизованную функцию для добавления заголовков аутентификации: