Ir al contenido

Claves de API

Las claves API de Ultralytics Platform permiten un acceso programático seguro para el entrenamiento remoto, la inferencia y la automatización. Cree claves con ámbitos específicos y permisos para diferentes casos de uso.

Crear Clave de API

Crear una nueva clave API:

  1. Ve a Configuración > Claves API
  2. Haz clic en Crear clave
  3. Introduzca un nombre para la clave
  4. Seleccione los ámbitos de permiso
  5. Haga clic en Crear

Nombre de la clave

Asigne un nombre descriptivo a su clave:

  • training-server - Para máquinas de entrenamiento remoto
  • ci-pipeline - Para integración CI/CD
  • mobile-app - Para aplicaciones móviles

Alcances de Permiso

Seleccione ámbitos para limitar los permisos de la clave:

AlcancePermisos
entrenamientoIniciar entrenamiento, transmitir métricas
modelosSubir, descargar, eliminar modelos
conjuntos de datosAcceder y modificar conjuntos de datos
lecturaAcceso de solo lectura a todos los recursos
escrituraAcceso de escritura completo
administradorGestión de cuentas (usar con precaución)

Mínimo privilegio

Cree claves solo con los permisos necesarios. Utilice claves separadas para diferentes aplicaciones.

Visualización de Clave

Después de la creación, la clave se muestra una sola vez:

Copie su clave

La clave completa se muestra solo una vez. Cópiela inmediatamente y guárdela de forma segura. No podrá recuperarla más tarde.

Formato de Clave

Las claves API siguen este formato:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
  • Prefijo: ul_ identifica las claves de Ultralytics
  • Cuerpo: 40 caracteres hexadecimales aleatorios
  • Total: 43 caracteres

Uso de Claves API

Variable de Entorno

Configure su clave como una variable de entorno:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

En Código

Utilice la clave en sus scripts de 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"

Encabezados HTTP

Incluya la clave en las solicitudes de API:

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

Entrenamiento Remoto

Habilite la transmisión de métricas con su clave.

Requisito de Versión del Paquete

La integración con la Plataforma requiere ultralytics>=8.4.0. Las versiones anteriores NO funcionarán con la Plataforma.

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

Gestionar Claves

Ver Claves

Todas las claves se enumeran en Ajustes > Claves de API:

ColumnaDescripción
NombreIdentificador de clave
ÁmbitosPermisos asignados
CreadaFecha de creación
Último usoUso más reciente

Revocar Clave

Revoque una clave que esté comprometida o que ya no sea necesaria:

  1. Haga clic en el menú de la clave
  2. Seleccione Revocar
  3. Confirme la revocación

Efecto inmediato

La revocación es inmediata. Cualquier aplicación que utilice la clave dejará de funcionar.

Regenerar Clave

Si una clave está comprometida:

  1. Cree una nueva clave con los mismos ámbitos
  2. Actualice sus aplicaciones
  3. Revoque la clave antigua

Mejores Prácticas de Seguridad

Qué hacer

  • Almacene las claves en variables de entorno
  • Utilice claves separadas para diferentes entornos
  • Revoque rápidamente las claves no utilizadas
  • Utilice los ámbitos mínimos requeridos
  • Rote las claves periódicamente

Qué no hacer

  • Confirme las claves en el control de versiones
  • Comparta claves entre aplicaciones
  • Utilice el ámbito de administrador innecesariamente
  • Registre las claves en la salida de la aplicación
  • Incruste las claves en el código del lado del cliente

Rotación de Claves

Rote las claves periódicamente por seguridad:

  1. Cree una nueva clave con los mismos ámbitos
  2. Actualice las aplicaciones para usar la nueva clave
  3. Verifique que las aplicaciones funcionen correctamente
  4. Revoque la clave antigua

Programa de rotación

Considere rotar las claves cada 90 días para aplicaciones sensibles.

Solución de problemas

Error de Clave Inválida

Error: Invalid API key

Soluciones:

  1. Verifique que la clave se haya copiado correctamente
  2. Compruebe que la clave no haya sido revocada
  3. Asegúrese de que la clave tenga los ámbitos requeridos
  4. Confirme que la variable de entorno esté configurada

Permiso Denegado

Error: Permission denied for this operation

Soluciones:

  1. Verifique que los ámbitos de la clave incluyan el permiso requerido
  2. Verifique que usted sea el propietario del recurso
  3. Cree una nueva clave con los ámbitos correctos

Límite de Tasa Alcanzado

Error: Rate limit exceeded

Soluciones:

  1. Reduzca la frecuencia de las solicitudes
  2. Implementar retroceso exponencial
  3. Contactar con soporte para un aumento de límite

Preguntas frecuentes

¿Cuántas claves puedo crear?

No hay un límite estricto en las claves API. Cree tantas como necesite para diferentes aplicaciones y entornos.

¿Las claves caducan?

Las claves no caducan automáticamente. Permanecen válidas hasta que se revocan. Considere implementar la rotación por seguridad.

¿Puedo ver mi clave después de la creación?

No, la clave completa se muestra solo una vez al crearla. Si se pierde, cree una nueva clave y revoque la anterior.

¿Las claves son específicas de una región?

Las claves funcionan en todas las regiones, pero solo acceden a los datos de la región de su cuenta.

¿Puedo compartir claves con miembros del equipo?

Mejor práctica: Que cada miembro del equipo cree su propia clave. Esto permite:

  • Seguimiento de actividad individual
  • Revocación selectiva
  • Control de acceso adecuado


📅 Creado hace 20 días ✏️ Actualizado hace 19 días
Laughing-qglenn-jocher

Comentarios