Claves de API

Las claves API Ultralytics permiten un acceso programático seguro para el entrenamiento remoto, la inferencia y la automatización. Cree claves con nombre con 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ácese hasta la sección Claves API.
3. Haz clic en Crear clave
4. Introduzca un nombre para la clave (por ejemplo, «Servidor de formación»).
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 el 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 el hash SHA-256 para una búsqueda rápida de prefijos y una comparación de hash.
• Los valores completos de las claves nunca se almacenan en texto sin formato.

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

Configure la clave utilizando laCLI 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 REST API para ver 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 Formación en la nube para obtener la guía completa de formación a distancia.

Gestionar Claves

Ver Claves

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

Cada tarjeta clave muestra el nombre de la clave, el valor completo descifrado de la clave (copiable), la hora relativa de creación y un botón de revocación.

Revocar Clave

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

1. Busca la clave en la sección 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 tienen un alcance limitado al espacio de trabajo actualmente activo:

• Espacio de trabajo personal: las claves se 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 API muestra las claves de ese espacio de trabajo. Se requiere el rol de editor o superior para gestionar las claves API del espacio de trabajo. Consulte Equipos para obtener más información 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 los objetivos principales.

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. Verifique que la clave se haya copiado correctamente (incluido el ul_ prefijo)
2. Compruebe que la clave no haya sido revocada
3. Confirme que la variable de entorno esté configurada
4. Asegúrate de que estás 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. Comprueba que la clave pertenece al espacio de trabajo correcto.
3. Cree una nueva clave si es necesario.

Límite de Tasa Alcanzado

Error: Rate limit exceeded

Soluciones:

1. Reduzca la frecuencia de las solicitudes; consulte la tabla de límites de frecuencia para conocer los límites por punto final.
2. Implementar retroceso exponencial utilizando el Retry-After encabezado
3. Utilice un punto final 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 > ProfileLa 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 su cuenta.

¿Puedo compartir claves con miembros del equipo?

Mejor práctica: Haga que cada miembro del equipo cree su propia clave. En los espacios de trabajo de equipo, cada miembro con el rol de editor o superior puede crear claves específicas para ese espacio de trabajo.

📅 Creado hace 1 mes ✏️ Actualizado hace 5 días

Comentarios