Chaves de API

Ultralytics Platform As chaves de API permitem acesso programático seguro para treinamento remoto, 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 seção Chaves de API
3. Clique em Criar Chave
4. Introduza um nome para a chave (por exemplo, "Servidor de Treino")
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 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 das Chaves

• As chaves são armazenadas com criptografia AES-256-GCM
• A autenticação utiliza hash SHA-256 para pesquisa rápida de prefixos e comparação de hashes
• Valores de chave completos 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 a CLI do 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 Reference para todos os endpoints 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 Cloud Training para o guia completo de treinamento remoto.

Gerenciar Chaves

Visualizar Chaves

Todas as chaves estão listadas em Settings > Profile na seção de Chaves de API:

Cada cartão de chave exibe o nome da chave, o valor completo da chave descriptografada (copiável), o tempo de criação relativo 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 seção Chaves de API
2. Clique no botão Revogar (lixeira)
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 de API do Workspace

As chaves de API são restritas ao espaço de trabalho atualmente ativo:

• Workspace pessoal: As chaves autenticam como sua conta pessoal
• Espaço de trabalho da equipe: As chaves autenticam-se no contexto da equipe

Ao alternar workspaces na barra lateral, a seção Chaves de API mostra as chaves para esse workspace. Função de Editor ou superior é necessária para gerenciar chaves de API do workspace. Consulte Equipes para detalhes da função.

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
• Utilize nomes descritivos para identificar propósitos-chave

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 você é o proprietário do recurso ou se tem acesso adequado ao espaço de trabalho
2. Verifique se a chave pertence ao workspace correto
3. Crie uma nova chave se necessário

Limite de Taxa Excedido

Error: Rate limit exceeded

Soluções:

1. Reduzir a frequência de solicitações — consulte a tabela de limites de taxa para limites por endpoint
2. Implemente o recuo exponencial utilizando o Retry-After cabeçalho
3. Utilize um endpoint dedicado para uma taxa de transferência de inferência ilimitada

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 são visíveis na lista de chaves em Settings > Profile. A Plataforma descriptografa e exibe suas chaves para que você 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: Faça com que cada membro da equipa crie a sua própria chave. Para espaços de trabalho de equipa, cada membro com função de Editor ou superior pode criar chaves com âmbito para esse espaço de trabalho.

📅 Criado há 2 meses ✏️ Atualizado há 5 dias

Comentários