Chaves de API

As chaves API Ultralytics permitem acesso programático seguro para formação remota, inferência e automação. Crie chaves nomeadas com criptografia AES-256-GCM para diferentes casos de uso.

Criar Chave de API

Criar uma nova chave API:

1. Vá para Configurações > Perfil
2. Role até a secção Chaves API
3. Clique em Criar Chave
4. Introduza um nome para a chave (por exemplo, «Servidor de Formação»).
5. Clique em Criar Chave

Nome da Chave

Atribua um nome descritivo à sua chave:

• training-server - Para máquinas de treinamento remoto
• ci-pipeline - Para integração CI/CD
• local-dev - Para o desenvolvimento local

Exibição da Chave

Após a criação, a chave é exibida uma única vez:

Formato da Chave

As chaves de API seguem este formato:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Prefixo: ul_ identifica chaves Ultralytics
• Corpo: 40 caracteres hexadecimais aleatórios
• Total: 43 caracteres

Segurança da chave

• As chaves são armazenadas com encriptação AES-256-GCM
• A autenticação utiliza hash SHA-256 para pesquisa rápida de prefixos e comparação de hash.
• Os valores completos das chaves nunca são armazenados em texto simples.

Usando Chaves de API

Variável de Ambiente

Defina sua chave como uma variável de ambiente:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

Defina a chave usando aCLI YOLO :

yolo settings api_key="ul_your_key_here"

No Código

Use a chave em seus scripts 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"

Cabeçalhos HTTP

Inclua a chave em requisições de API:

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

Consulte a REST API para ver todos os pontos finais disponíveis.

Treinamento Remoto

Habilite o streaming de métricas com sua chave.

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 Formação em nuvem para obter o guia completo de formação remota.

Gerenciar Chaves

Visualizar Chaves

Todas as teclas estão listadas em Settings > Profile na secção Chaves API:

Cada cartão-chave mostra o nome da chave, o valor completo da chave descriptografada (copiável), a hora relativa de criação e um botão de revogação.

Revogar Chave

Revogar uma chave comprometida ou que não é mais necessária:

1. Encontre a chave na secção Chaves API
2. Clique no botão Revogar (lixo)
3. Confirmar revogação

Regenerar Chave

Se uma chave for comprometida:

1. Crie uma nova chave com o mesmo nome
2. Atualizar suas aplicações
3. Revogar a chave antiga

Chaves API do espaço de trabalho

As chaves API têm o âmbito do espaço de trabalho atualmente ativo:

• Espaço de trabalho pessoal: as chaves autenticam-se como a sua conta pessoal
• Espaço de trabalho da equipa: as chaves são autenticadas dentro do contexto da equipa

Ao alternar entre espaços de trabalho na barra lateral, a secção Chaves API mostra as chaves para esse espaço de trabalho. É necessária a função de editor ou superior para gerir as chaves API do espaço de trabalho. Consulte Equipas para obter detalhes sobre as funções.

Melhores Práticas de Segurança

Fazer

• Armazenar chaves em variáveis de ambiente
• Utilizar chaves separadas para diferentes ambientes
• Revogar chaves não utilizadas prontamente
• Rotacionar chaves periodicamente
• Use nomes descritivos para identificar os principais objetivos

Não Fazer

• Fazer commit de chaves para controle de versão
• Compartilhar chaves entre aplicações
• Registrar chaves na saída da aplicação
• Incorporar chaves em código do lado do cliente

Rotação de Chaves

Rotacionar chaves periodicamente por segurança:

1. Criar nova chave com o mesmo nome
2. Atualizar aplicações para usar a nova chave
3. Verificar se as aplicações funcionam corretamente
4. Revogar chave antiga

Resolução de Problemas

Erro de Chave Inválida

Error: Invalid API key

Soluções:

1. Verifique se a chave foi copiada corretamente (incluindo o ul_ prefixo)
2. Verificar se a chave não foi revogada
3. Confirmar que a variável de ambiente está definida
4. Certifique-se de que está a utilizar ultralytics>=8.4.14

Permissão Negada

Error: Permission denied for this operation

Soluções:

1. Verifique se é o proprietário do recurso ou se tem acesso adequado ao espaço de trabalho.
2. Verifique se a chave pertence ao espaço de trabalho correto
3. Crie uma nova chave, se necessário

Limite de Taxa Excedido

Error: Rate limit exceeded

Soluções:

1. Reduza a frequência de solicitações — consulte a tabela de limites de taxa para limites por ponto final
2. Implemente o recuo exponencial usando o Retry-After cabeçalho
3. Use um endpoint dedicado para throughput de inferência ilimitado

FAQ

Quantas chaves posso criar?

Não há limite rígido para chaves de API. Crie quantas forem necessárias para diferentes aplicações e ambientes.

As chaves expiram?

As chaves não expiram automaticamente. Elas permanecem válidas até serem revogadas. Considere implementar a rotação para segurança.

Posso ver minha chave após a criação?

Sim, os valores completos das chaves estão visíveis na lista de chaves em Settings > Profile. A Plataforma descodifica e exibe as suas chaves para que possa copiá-las a qualquer momento.

As chaves são específicas da região?

As chaves funcionam em todas as regiões, mas acessam dados apenas na região da sua conta.

Posso partilhar chaves com membros da equipa?

Melhor prática: peça a cada membro da equipa para criar a sua própria chave. Para espaços de trabalho em equipa, cada membro com função de Editor ou superior pode criar chaves específicas para esse espaço de trabalho.

📅 Criado há 1 mês ✏️ Atualizado há 5 dias

Comentários