Перейти к содержимому

Аутентификация и API-ключи

Создайте ключ API sk_ в Центре API . Полный ключ отображается только один раз — при его создании или смене.

Используйте отдельный ключ для каждого приложения, окружения и автоматизированной задачи, чтобы каждый из них мог иметь собственный бюджет и быть самостоятельно отключён, заменён и проверен.

Рекомендуется:

X-API-Key: sk_your_key

Стандартная форма Bearer также работает:

Authorization: Bearer sk_your_key

Отправляйте в запросе только один из двух.

Окно терминала
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Ключ действует в рамках учётной записи, его создавшей: он может вызывать службы, доступные для этой учётной записи, и обращаться только к ресурсам этой учётной записи. Ключ не может изменять адрес электронной почты для входа, пароль, номер телефона или профиль, а также не может создавать, обновлять или отзывать ключи API.

Необязательные пределы:

  • allowed_engines: только перечисленные настройки перевода; пустой массив не устанавливает ограничений на уровне ключей.
  • expires_at: время истечения срока действия.
  • quota_limit: лимит времени жизни ключа в целых милликредитах; 0 не устанавливает лимит на уровне ключа, и кредиты учётной записи списываются в обычном порядке.

Создавайте ключи, изменяйте их ограничения, выполняйте их ротацию или отзывайте в центре API . После отзыва, отключения или истечения срока действия ключа либо при отключении соответствующей учётной записи новые запросы немедленно завершаются ошибкой.

При ротации создаётся новый секрет, а старый сразу отключается; новый ключ сохраняет исходные ограничения и уже использованный бюджет. Истёкший срок действия ключ не подлежит ротации — создайте новый. Для бесперебойного переключения сначала создайте и разверните новый ключ, убедитесь, что вызовы выполняются успешно, затем отзовите старый ключ.

  • Храните ключи только на сервере или в контролируемой среде выполнения.
  • Используйте переменные окружения или менеджер секретов; никогда не размещайте ключи в исходном коде, логах, бандлах для браузера или публичных репозиториях.
  • Никогда не отправляйте ключ для адресов загрузки или скачивания, возвращённых API.
  • Записывайте идентификатор ключа, идентификатор запроса и идентификатор операции; никогда не записывайте полный ключ.
  • Если ключ утечка, немедленно замените его и проверьте связанные с ним задания и начисления.