Ключи 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=yolo11n.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-ключей. Создавайте столько, сколько необходимо для различных приложений и сред.

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

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

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

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

Ключи зависят от региона?

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

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

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

• Отслеживание индивидуальной активности
• Избирательная отмена
• Надлежащий контроль доступа

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

Комментарии