Link to this sectionAPI-ключи#

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

Link to this sectionСоздать API-ключ#

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

1. Перейди в Настройки > API-ключи
2. Нажми Создать ключ
3. Введи имя для ключа (например, "Training Server")
4. Нажми Создать ключ

Link to this sectionИмя ключа#

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

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

Link to this sectionОтображение ключа#

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

Link to this sectionФормат ключа#

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

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

Link to this sectionБезопасность ключа#

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

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

Link to this sectionПеременная окружения#

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

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Установи ключ с помощью YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionВ коде#

Используй ключ в своих скриптах на Python:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

Link to this sectionHTTP-заголовки#

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

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

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

Link to this sectionУдаленное обучение#

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

pip install "ultralytics>=8.4.60"

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

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

Link to this sectionУправление ключами#

Link to this sectionПросмотр ключей#

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

Каждая карточка ключа показывает имя ключа, полное расшифрованное значение ключа (которое можно скопировать), относительное время создания и кнопку отзыва.

Link to this sectionОтзыв ключа#

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

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

Link to this sectionПерегенерация ключа#

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

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

Link to this sectionAPI-ключи рабочего пространства#

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

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

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

Link to this sectionРекомендации по безопасности#

Link to this sectionДелай#

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

Link to this sectionНе делай#

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

Link to this sectionСмена ключей#

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

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

Link to this sectionУстранение неполадок#

Link to this sectionОшибка недействительного ключа#

Решения:

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

Link to this sectionДоступ запрещен#

Решения:

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

Link to this sectionПревышение лимита запросов#

Решения:

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

Link to this sectionЧасто задаваемые вопросы#

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

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

Link to this sectionИстекает ли срок действия ключей?#

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

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

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

Link to this sectionПривязаны ли ключи к определенному региону?#

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

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

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