Ключи API

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

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

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

1. Перейдите в Настройки > Ключи API
2. Нажмите Создать ключ
3. Введите имя для ключа
4. Выберите области разрешений
5. Нажмите Создать

Имя ключа

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

• training-server - Для удаленных обучающих машин
• ci-pipeline - Для интеграции CI/CD
• mobile-app - Для мобильных приложений

Области разрешений

Выберите области действия для ограничения разрешений ключа:

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

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

Формат ключа

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

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

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

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

Переменная среды

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

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_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/...

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

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

pip install "ultralytics>=8.4.0"

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

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

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

Все ключи перечислены в разделе «Настройки > Ключи API»:

Отзыв ключа

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

1. Нажмите на меню ключа
2. Выберите Отозвать
3. Подтвердите отзыв

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

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

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

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

Разрешено

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

Запрещено

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

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

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

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

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

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

Error: Invalid API key

Решения:

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

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

Error: Permission denied for this operation

Решения:

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

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

Error: Rate limit exceeded

Решения:

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

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

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

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

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

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

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

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

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

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

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

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

• Отслеживание индивидуальной активности
• Выборочный отзыв
• Надлежащий контроль доступа

📅 Создано 20 дней назад ✏️ Обновлено 19 дней назад

Комментарии