Claves de API

Las claves de API de Ultralytics Platform permiten un acceso programático seguro para el entrenamiento remoto, la inferencia y la automatización. Crea claves con nombre y cifrado AES-256-GCM para diferentes casos de uso.

Crear clave de API

Crea una nueva clave de API:

1. Ve a Configuración > Claves de API
2. Haz clic en Crear clave
3. Introduce un nombre para la clave (p. ej., "Servidor de entrenamiento")
4. Haz clic en Crear clave

Nombre de la clave

Dale a tu clave un nombre descriptivo:

• training-server - Para máquinas de entrenamiento remoto
• ci-pipeline - Para integración CI/CD
• local-dev - Para desarrollo local

Visualización de la clave

Tras la creación, la clave se muestra una única vez:

Formato de clave

Las claves de API siguen este formato:

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

Seguridad de las claves

• Las claves se almacenan con cifrado AES-256-GCM
• La autenticación utiliza el hash SHA-256 para una búsqueda rápida de prefijos y comparación de hashes
• Los valores completos de las claves nunca se almacenan en texto plano

Uso de claves de API

Variable de entorno

Establece tu clave como una variable de entorno:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI

Establece la clave usando el YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

En código

Usa la clave en tus scripts de Python:

import os

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

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

Cabeceras HTTP

Incluye la clave en las solicitudes de API:

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

Consulta la Referencia de REST API para ver todos los puntos finales disponibles.

Entrenamiento remoto

Habilita el streaming de métricas con tu clave.

pip install "ultralytics>=8.4.35"

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

Consulta Cloud Training para obtener la guía completa de entrenamiento remoto.

Gestionar claves

Ver claves

All keys are listed on the Settings > API Keys tab:

Cada tarjeta de clave muestra el nombre de la clave, el valor completo descifrado (se puede copiar), la fecha relativa de creación y un botón para revocarla.

Revocar clave

Revoca una clave si está comprometida o ya no la necesitas:

1. Busca la clave en la sección de Claves de API
2. Haz clic en el botón Revocar (papelera)
3. Confirma la revocación

Regenerar clave

Si una clave está comprometida:

1. Crea una clave nueva con el mismo nombre
2. Actualiza tus aplicaciones
3. Revoca la clave antigua

Claves de API del área de trabajo

Las claves de API están vinculadas al área de trabajo activa actualmente:

• Área de trabajo personal: Las claves se autentican como tu cuenta personal
• Área de trabajo de equipo: Las claves se autentican dentro del contexto del equipo

Al cambiar de área de trabajo en la barra lateral, la sección de Claves de API muestra las claves correspondientes a dicha área. Se requiere el rol de Editor o superior para gestionar las claves de API del área de trabajo. Consulta Equipos para ver los detalles sobre los roles.

Buenas prácticas de seguridad

Qué hacer

• Almacena las claves en variables de entorno
• Usa claves separadas para diferentes entornos
• Revoca rápidamente las claves no utilizadas
• Rota las claves periódicamente
• Usa nombres descriptivos para identificar los propósitos de las claves

Qué no hacer

• Incluir claves en el control de versiones
• Compartir claves entre aplicaciones
• Registrar claves en la salida de la aplicación
• Insertar claves en código del lado del cliente

Rotación de claves

Rota las claves periódicamente por seguridad:

1. Crea una nueva clave con el mismo nombre
2. Actualiza las aplicaciones para usar la nueva clave
3. Verifica que las aplicaciones funcionen correctamente
4. Revoca la clave antigua

Solución de problemas

Error de clave no válida

Soluciones:

1. Verifica que la clave se haya copiado correctamente (incluyendo el prefijo ul_)
2. Comprueba que la clave no haya sido revocada
3. Confirma que la variable de entorno esté configurada
4. Asegúrate de estar usando ultralytics>=8.4.35

Acceso denegado

Soluciones:

1. Verifica que eres el propietario del recurso o que tienes el acceso adecuado al área de trabajo
2. Comprueba que la clave pertenezca al área de trabajo correcta
3. Crea una clave nueva si es necesario

Límite de velocidad alcanzado

Soluciones:

1. Reduce la frecuencia de las solicitudes; consulta la tabla de límites de velocidad para conocer los límites por punto final
2. Implementa un retroceso exponencial usando la cabecera Retry-After
3. Usa un punto final dedicado para una capacidad de inferencia ilimitada

Preguntas frecuentes

¿Cuántas claves puedo crear?

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

¿Caducan las claves?

Las claves no caducan automáticamente. Permanecen válidas hasta que se revoquen. Considera implementar una rotación por seguridad.

¿Puedo ver mi clave después de crearla?

Sí, los valores completos de las claves son visibles en la lista de claves en Settings > API Keys. La plataforma descifra y muestra tus claves para que puedas copiarlas en cualquier momento.

¿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 tu cuenta.

¿Puedo compartir las claves con los miembros del equipo?

Mejor práctica: haz que cada miembro del equipo cree su propia clave. Para espacios de trabajo de equipo, cada miembro con rol de Editor o superior puede crear claves vinculadas a ese espacio de trabajo.