Chaves API

As chaves API Ultralytics permitem acesso programático seguro para formação remota, inferência e automação. Crie chaves com permissões específicas para diferentes casos de uso.

Criar chave API

Crie uma nova chave API:

1. Vá para Definições > Chaves API
2. Clique em Criar chave
3. Introduza um nome para a chave
4. Selecione os âmbitos de permissão
5. Clique em Criar

Nome da chave

Dê um nome descritivo à sua chave:

• training-server - Para máquinas de treino remoto
• ci-pipeline - Para integração CI/CD
• mobile-app - Para aplicações móveis

Âmbitos de permissão

Selecione os escopos para limitar as permissões principais:

Exibição de teclas

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

Formato da chave

As chaves API seguem este formato:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

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

Usando chaves API

Variável de ambiente

Defina a sua chave como uma variável de ambiente:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

Em código

Use a chave nos seus 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 nas solicitações da API:

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

Formação à distância

Ative a transmissão de métricas com a sua chave.

pip install "ultralytics>=8.4.0"

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

Gerir chaves

Chaves de visualização

Todas as chaves estão listadas em Definições > Chaves API:

Revogar chave

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

1. Clique no menu da tecla
2. Selecione Revogar
3. Confirmar revogação

Regenerar chave

Se uma chave for comprometida:

1. Crie uma nova chave com os mesmos escopos
2. Atualize as suas aplicações
3. Revogar a chave antiga

Melhores práticas de segurança

Faça

• Armazene as chaves em variáveis de ambiente
• Use chaves separadas para ambientes diferentes
• Revogue imediatamente as chaves não utilizadas
• Use os escopos mínimos necessários
• Rote as chaves periodicamente

Não

• Enviar chaves para o controlo de versão
• Partilhar chaves entre aplicações
• Usar o âmbito administrativo desnecessariamente
• Registar chaves na saída da aplicação
• Incorporar chaves no código do lado do cliente

Rotação de chaves

Alterne as chaves periodicamente por motivos de segurança:

1. Criar nova chave com os mesmos âmbitos
2. Atualizar aplicações para usar a nova chave
3. Verifique 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
2. Verifique se a chave não foi revogada
3. Certifique-se de que a chave tem os escopos necessários
4. Confirme se a variável de ambiente está definida

Permissão negada

Error: Permission denied for this operation

Soluções:

1. Verifique se os escopos das chaves incluem as permissões necessárias
2. Confirme que é o proprietário do recurso
3. Criar nova chave com os escopos corretos

Taxa limitada

Error: Rate limit exceeded

Soluções:

1. Reduzir a frequência de pedidos
2. Implementar recuo exponencial
3. Entre em contacto com o suporte para aumentar o limite

FAQ

Quantas chaves posso criar?

Não há limite rígido para chaves 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 por motivos de segurança.

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

Não, a chave completa é mostrada apenas uma vez na criação. Se a perder, crie uma nova chave e revogue a antiga.

As chaves são específicas para cada região?

As chaves funcionam em todas as regiões, mas só é possível aceder aos dados 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. Isso permite:

• Acompanhamento de atividades individuais
• Revogação seletiva
• Controlo de acesso adequado

📅 Criado há 0 dias ✏️ Atualizado há 0 dias

Comentários