Ir al contenido

Claves API

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

Crear clave API

Crear una nueva clave API:

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

Nombre clave

Asigna un nombre descriptivo a tu clave:

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

Ámbitos de permiso

Selecciona ámbitos para limitar los permisos clave:

AlcancePermisos
entrenamientoComienza el entrenamiento, transmite métricas
modelosSubir, descargar, eliminar modelos
conjuntos de datosAcceder y modificar conjuntos de datos
leerAcceso de solo lectura a todos los recursos
escribirAcceso completo de escritura
administradorGestión de cuentas (utilizar con precaución)

Privilegio mínimo

Cree claves solo con los permisos necesarios. Utilice claves diferentes para cada aplicación.

Pantalla de teclas

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

Copie su clave

La clave completa solo se muestra una vez. Cópiala inmediatamente y guárdala en un lugar seguro. No podrás recuperarla más adelante.

Formato clave

Las claves API siguen este formato:

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

Uso de claves API

Variable de entorno

Establece tu clave como variable de entorno:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

En código

Utiliza la clave en tus 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

Incluye la clave en las solicitudes API:

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

Formación a distancia

Habilita la transmisión de métricas con tu clave.

Requisitos de la versión del paquete

La integración con Platform requiere ultralytics>= 8.4.0. Las versiones inferiores NO funcionarán con Platform.

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

Gestionar claves

Ver claves

Todas las claves se enumeran en Configuración > Claves API:

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

Revocar clave

Revocar una clave que se ha visto comprometida o que ya no es necesaria:

  1. Haga clic en el menú de la tecla.
  2. Seleccionar Revocar
  3. Confirmar revocación

Efecto inmediato

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

Regenerar clave

Si una clave se ve comprometida:

  1. Crear una nueva clave con los mismos ámbitos
  2. Actualiza tus aplicaciones
  3. Revocar la clave antigua

Mejores prácticas de seguridad

Hazlo

  • Almacenar claves en variables de entorno
  • Utilice claves diferentes para cada entorno.
  • Revocar rápidamente las claves no utilizadas
  • Utilice los ámbitos mínimos necesarios.
  • Rote las llaves periódicamente.

No

  • Confirmar claves en el control de versiones
  • Compartir claves entre aplicaciones
  • Usar el ámbito de administración innecesariamente
  • Registrar claves en la salida de la aplicación
  • Incrustar claves en el código del lado del cliente

Rotación de llaves

Rote las claves periódicamente por motivos de seguridad:

  1. Crear nueva clave con los mismos ámbitos
  2. Actualizar las aplicaciones para utilizar la nueva clave.
  3. Verificar que las aplicaciones funcionan correctamente.
  4. Revocar clave antigua

Calendario de rotación

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

Solución de problemas

Error de clave no válida

Error: Invalid API key

Soluciones:

  1. Comprueba que la clave se ha copiado correctamente.
  2. Comprueba que la clave no haya sido revocada.
  3. Asegúrese de que la clave tenga los ámbitos necesarios.
  4. Confirmar que la variable de entorno está configurada.

Permiso denegado

Error: Permission denied for this operation

Soluciones:

  1. Comprueba que los ámbitos clave incluyan los permisos necesarios.
  2. Verifique que es el propietario del recurso.
  3. Crear una nueva clave con los ámbitos correctos.

Tasa limitada

Error: Rate limit exceeded

Soluciones:

  1. Reducir la frecuencia de las solicitudes
  2. Implementar retroceso exponencial
  3. Póngase en contacto con el servicio de asistencia para solicitar un aumento del límite.

Preguntas frecuentes

¿Cuántas claves puedo crear?

No hay un límite estricto para las claves API. Crea tantas como necesites para diferentes aplicaciones y entornos.

¿Las claves caducan?

Las claves no caducan automáticamente. Siguen siendo válidas hasta que se revocan. Considere implementar una rotación por motivos de seguridad.

¿Puedo ver mi clave después de crearla?

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

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

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

¿Puedo compartir claves con los miembros del equipo?

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

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


📅 Creado hace 0 días ✏️ Actualizado hace 0 días
glenn-jocher

Comentarios