Перейти до вмісту

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

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

Використовуйте окремий ключ для кожного застосунку, середовища та автоматизованої задачі, щоб кожен мав власний бюджет і міг бути самостійно вимкнений, оновлений та перевірений.

Надішліть облікові дані

Section titled “Надішліть облікові дані”

Рекомендовано:

X-API-Key: sk_your_key

Стандартна форма Bearer також працює:

Authorization: Bearer sk_your_key

Надсилайте лише один із двох у запиті.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Що представляє собою ключ

Section titled “Що представляє собою ключ”

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

Необов’язкові межі:

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

Обертання та скасування

Section titled “Обертання та скасування”

Створюйте ключі, змінюйте їхні обмеження, оновлюйте або скасовуйте їх у центрі API . Після скасування, вимкнення або закінчення терміну дії ключа, або коли вимкнено його обліковий запис, нові запити одразу ж помилково відхиляються.

Ротація одразу створює новий секрет і деактивує старий; новий ключ зберігає початкові ліміти та вже використаний бюджет. Терміново прострочений ключ не підлягає ротації; створіть новий. Для безперебійного переходу спочатку створіть новий ключ і розгорніть його, переконайтеся, що виклики успішні, а потім скасуйте старий ключ.

  • Зберігайте ключі лише на сервері або в контрольованому середовищі виконання.
  • Використовуйте змінні середовища або менеджер секретів; ніколи не розміщуйте ключі у вихідному коді, журналах, пакетах для браузерів або публічних репозиторіях.
  • Ніколи не надсилайте ключ до адрес завантаження або завантаження, які повертає API.
  • Записуйте ідентифікатор ключа, ідентифікатор запиту та ідентифікатор операції; ніколи не записуйте повний ключ.
  • Якщо ключ став відомий зловмисникам, негайно замініть його та перевірте пов’язані з ним завдання й обов’язки.