Claves de API

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

Crear Clave de API

Crear una nueva clave API:

1. Vaya a Configuración > Perfil
2. Desplázate a la sección Claves de API
3. Haz clic en Crear clave
4. Introduzca un nombre para la clave (ej., "Servidor de Entrenamiento")
5. Haz clic en Crear clave

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
• local-dev - Para desarrollo local

Visualización de Clave

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

Formato de Clave

Las claves API siguen este formato:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

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

Seguridad clave

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

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"

YOLO CLI

Establezca la clave usando la CLI de YOLO:

yolo settings 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/...

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

Entrenamiento Remoto

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

pip install "ultralytics>=8.4.14"

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

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

Gestionar Claves

Ver Claves

Todas las claves se enumeran en Settings > Profile en la sección de Claves de API:

Cada tarjeta de clave muestra el nombre de la clave, el valor completo de la clave descifrada (copiable), el tiempo de creación relativo y un botón de revocación.

Revocar Clave

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

1. Busque la clave en la sección de Claves API
2. Haga clic en el botón Revocar (papelera).
3. Confirme la revocación

Regenerar Clave

Si una clave está comprometida:

1. Crear una nueva clave con el mismo nombre
2. Actualice sus aplicaciones
3. Revoque la clave antigua

Claves API del Espacio de Trabajo

Las claves API están restringidas al espacio de trabajo actualmente activo:

• Espacio de trabajo personal: Las claves autentican como su cuenta personal
• Espacio de trabajo del equipo: Las claves se autentican dentro del contexto del equipo

Al cambiar de espacio de trabajo en la barra lateral, la sección Claves de API muestra las claves para ese espacio de trabajo. Se requiere un rol de Editor o superior para gestionar las claves de API del espacio de trabajo. Consulte Equipos para obtener detalles sobre los roles.

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
• Rote las claves periódicamente
• Utilice nombres descriptivos para identificar propósitos clave

Qué no hacer

• Confirme las claves en el control de versiones
• Comparta claves entre aplicaciones
• 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. Crear nueva clave con el mismo nombre
2. Actualice las aplicaciones para usar la nueva clave
3. Verifique que las aplicaciones funcionen correctamente
4. Revoque la clave antigua

Solución de problemas

Error de Clave Inválida

Error: Invalid API key

Soluciones:

1. Verificar que la clave se copie correctamente (incluyendo el ul_ prefijo)
2. Compruebe que la clave no haya sido revocada
3. Confirme que la variable de entorno esté configurada
4. Asegúrese de que está utilizando ultralytics>=8.4.14

Permiso Denegado

Error: Permission denied for this operation

Soluciones:

1. Verifique que es el propietario del recurso o que tiene acceso adecuado al espacio de trabajo.
2. Verifique que la clave pertenezca al espacio de trabajo correcto
3. Crear una nueva clave si es necesario

Límite de Tasa Alcanzado

Error: Rate limit exceeded

Soluciones:

1. Reducir la frecuencia de las solicitudes — consulte la tabla de límites de tasa para los límites por punto final
2. Implementar retroceso exponencial utilizando el Retry-After encabezado
3. Utilice un endpoint dedicado para un rendimiento de inferencia ilimitado

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?

Sí, los valores completos de las claves son visibles en la lista de claves en Settings > Profile. La Plataforma descifra y muestra sus claves para que pueda 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 su cuenta.

¿Puedo compartir claves con miembros del equipo?

Mejor práctica: Que cada miembro del equipo cree su propia clave. Para espacios de trabajo en equipo, cada miembro con rol de Editor o superior puede crear claves con ámbito para ese espacio de trabajo.

📅 Creado hace 2 meses ✏️ Actualizado hace 5 días

Comentarios