Ключи API

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

Создать ключ API

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

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

Имя ключа

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

• 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="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

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

yolo settings api_key="ul_your_key_here"

В коде

Используйте ключ в ваших python-скриптах:

import os

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

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

HTTP-заголовки

Передавайте ключ в запросах API:

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

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

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

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

pip install "ultralytics>=8.4.14"

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

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

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

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

Все ключи перечислены в Settings > Profile в разделе «Ключи API»:

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

Отзыв ключа

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

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

Повторная генерация ключа

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

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

Ключи API рабочей области

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

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

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

Рекомендации по безопасности

Разрешено

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

Запрещено

• Размещайте ключи в системе контроля версий
• Совместно используйте ключи между приложениями
• Регистрируйте ключи в выводе приложения
• Встраивайте ключи в клиентский код

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

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

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

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

Ошибка недействительного ключа

Error: Invalid API key

Решения:

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

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

Error: Permission denied for this operation

Решения:

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

Ограничение частоты запросов

Error: Rate limit exceeded

Решения:

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

Часто задаваемые вопросы

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

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

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

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

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

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

Являются ли ключи региональными?

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

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

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

📅 Создано 2 месяцев назад ✏️ Обновлено 5 дней назад

Комментарии