API-ключи#

API-ключи Ultralytics Platform обеспечивают безопасный программный доступ для удаленного обучения, логического вывода и автоматизации. Создавай именованные ключи с шифрованием AES-256-GCM для различных сценариев использования.

Создать API key#

Создай новый API-ключ:

1. Перейди в Settings > API Keys
2. Нажми Create Key
3. Введи название ключа (например, "Training Server")
4. Нажми Create Key

Название ключа#

Дай своему ключу описательное название:

• training-server — для удаленных машин обучения
• ci-pipeline — для CI/CD интеграции
• local-dev — для локальной разработки

Отображение ключа#

После создания ключ отображается в диалоговом окне подтверждения:

Формат ключа#

API-ключи имеют следующий формат:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Префикс: ul_ идентифицирует ключи Ultralytics
• Тело: 40 случайных шестнадцатеричных символов
• Всего: 43 символа

Безопасность ключей#

• Ключи хранятся с использованием шифрования AES-256-GCM
• Для аутентификации используется хеш SHA-256 для быстрого индексированного поиска
• Полные значения ключей никогда не хранятся в открытом виде

Использование API-ключей#

Переменная окружения#

Установи ключ в качестве переменной окружения:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Проверь и сохрани ключ с помощью YOLO CLI:

yolo login YOUR_API_KEY

Удали сохраненный ключ с помощью yolo logout.

HTTP-заголовки#

Включай ключ в API-запросы:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

Смотри REST API Reference для получения списка всех доступных эндпоинтов.

Удаленное обучение#

Включи потоковую передачу метрик с помощью своего ключа.

Установи или обнови пакет Ultralytics перед началом работы:

pip install -U ultralytics

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Смотри Cloud Training для получения полного руководства по удаленному обучению.

Управление ключами#

Просмотр ключей#

Все ключи перечислены на вкладке Settings > API Keys:

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

Отзыв ключа#

Отозови ключ, если он скомпрометирован или больше не нужен:

1. Найди ключ в разделе API Keys
2. Нажми кнопку Revoke (корзина)
3. Подтверди отзыв

Перегенерация ключа#

Если ключ скомпрометирован:

1. Создай новый ключ с тем же названием
2. Обнови свои приложения
3. Отозови старый ключ

API-ключи рабочего пространства#

API-ключи привязаны к текущему активному рабочему пространству:

• Личное рабочее пространство: Ключи аутентифицируют тебя как личный аккаунт
• Командное рабочее пространство: Ключи аутентифицируют в контексте команды

При переключении рабочих пространств в боковой панели раздел API Keys показывает ключи именно для этого пространства. Для управления API-ключами рабочего пространства требуется роль редактора или выше. Подробности о ролях смотри в Teams.

Лучшие практики безопасности#

Делай#

• Храни ключи в переменных окружения
• Используй отдельные ключи для разных сред
• Своевременно отзывай неиспользуемые ключи
• Периодически меняй (ротируй) ключи
• Используй описательные названия для определения назначения ключей

Не делай#

• Не коммить ключи в систему контроля версий
• Не делись ключами между приложениями
• Не выводи ключи в логах приложения
• Не встраивай ключи в клиентский код

Ротация ключей#

Периодически меняй ключи в целях безопасности:

1. Создай новый ключ с тем же названием
2. Обнови приложения, чтобы они использовали новый ключ
3. Проверь, что приложения работают корректно
4. Отозови старый ключ

Устранение неполадок#

Ошибка неверного ключа#

Error: Invalid API key

Решения:

1. Проверь, правильно ли скопирован ключ (включая префикс ul_)
2. Убедись, что ключ не был отозван
3. Подтверди, что переменная окружения установлена
4. Убедись, что ты используешь ultralytics>=8.4.104

Доступ запрещен#

Error: Permission denied for this operation

Решения:

1. Проверь, что ты являешься владельцем ресурса или имеешь соответствующий доступ к рабочему пространству
2. Проверь, что ключ принадлежит нужному рабочему пространству
3. Создай новый ключ, если это необходимо

Превышение лимита запросов (Rate Limited)#

Error: Rate limit exceeded

Решения:

1. Сократи частоту запросов — смотри таблицу лимитов для ограничений по каждому эндпоинту
2. Реализуй экспоненциальную задержку (exponential backoff) с использованием заголовка Retry-After
3. Используй специальную конечную точку, когда тебе нужна изолированная емкость для инференса

FAQ#

Сколько ключей я могу создать?#

Жесткого лимита на количество API-ключей нет. Создавай столько, сколько нужно для разных приложений и сред.

Срок действия ключей истекает?#

Срок действия ключей автоматически не истекает. Они остаются действительными до момента отзыва. В целях безопасности рассмотри возможность внедрения ротации.

Могу ли я увидеть свой ключ после создания?#

Да, полные значения ключей видны в списке на Settings > API Keys. Платформа расшифровывает и отображает твои ключи, чтобы ты мог скопировать их в любое время.

Привязаны ли ключи к регионам?#

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

Могу ли я делиться ключами с членами команды?#

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