Chiavi API

Le chiavi API della piattaforma Ultralytics consentono un accesso programmatico sicuro per l'addestramento remoto, l'inferenza e l'automazione. Crea chiavi nominate con crittografia AES-256-GCM per diversi casi d'uso.

Crea chiave API

Crea una nuova chiave API:

1. Vai a Impostazioni > Profilo
2. Scorri fino alla sezione Chiavi API
3. Clicca su Crea chiave
4. Inserisci un nome per la chiave (ad es., "Server di Addestramento")
5. Clicca su Crea chiave

Nome Chiave

Assegna un nome descrittivo alla tua chiave:

• training-server - Per macchine di addestramento remoto
• ci-pipeline - Per l'integrazione CI/CD
• local-dev - Per lo sviluppo locale

Visualizzazione Chiave

Dopo la creazione, la chiave viene visualizzata una sola volta:

Formato Chiave

Le chiavi API seguono questo formato:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Prefisso: ul_ identifica le chiavi Ultralytics
• Corpo: 40 caratteri esadecimali casuali
• Totale: 43 caratteri

Sicurezza delle chiavi

• Le chiavi sono memorizzate con crittografia AES-256-GCM
• L'autenticazione utilizza l'hash SHA-256 per una rapida ricerca di prefissi e confronto di hash
• I valori chiave completi non vengono mai memorizzati in chiaro

Utilizzo delle Chiavi API

Variabile d'Ambiente

Impostare la chiave come variabile d'ambiente:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

Imposta la chiave usando la CLI di YOLO:

yolo settings api_key="ul_your_key_here"

Nel Codice

Utilizzare la chiave negli script 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"

Header HTTP

Includere la chiave nelle richieste API:

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

Consultare il Riferimento REST API per tutti gli endpoint disponibili.

Addestramento remoto

Abilitare lo streaming delle metriche con la propria chiave.

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

Consulta Addestramento su Cloud per la guida completa all'addestramento remoto.

Gestisci Chiavi

Visualizza Chiavi

Tutte le chiavi sono elencate in Settings > Profile nella sezione Chiavi API:

Ogni scheda chiave mostra il nome della chiave, il valore completo della chiave decifrata (copiabile), il tempo di creazione relativo e un pulsante di revoca.

Revoca Chiave

Revocare una chiave compromessa o non più necessaria:

1. Trova la chiave nella sezione Chiavi API
2. Clicca il pulsante Revoca (cestino)
3. Conferma la revoca

Rigenera Chiave

Se una chiave è compromessa:

1. Crea una nuova chiave con lo stesso nome
2. Aggiorna le tue applicazioni
3. Revoca la vecchia chiave

Chiavi API dello spazio di lavoro

Le chiavi API sono limitate all'area di lavoro attualmente attiva:

• Workspace personale: Le chiavi autenticano come il tuo account personale
• Spazio di lavoro del team: Le chiavi si autenticano nel contesto del team

Quando si cambiano gli spazi di lavoro nella barra laterale, la sezione Chiavi API mostra le chiavi per quello spazio di lavoro. È richiesto il ruolo di Editor o superiore per gestire le chiavi API dello spazio di lavoro. Vedere Team per i dettagli sui ruoli.

Migliori Pratiche di Sicurezza

Fai

• Archivia le chiavi nelle variabili d'ambiente
• Utilizza chiavi separate per ambienti diversi
• Revoca tempestivamente le chiavi non utilizzate
• Ruota periodicamente le chiavi
• Utilizzare nomi descrittivi per identificare gli scopi principali

Non fare

• Non effettuare il commit delle chiavi nel controllo versione
• Non condividere le chiavi tra applicazioni
• Non registrare le chiavi nell'output dell'applicazione
• Non incorporare le chiavi nel codice lato client

Rotazione delle Chiavi

Ruota periodicamente le chiavi per sicurezza:

1. Crea nuova chiave con lo stesso nome
2. Aggiorna le applicazioni per utilizzare la nuova chiave
3. Verifica che le applicazioni funzionino correttamente
4. Revoca la vecchia chiave

Risoluzione dei problemi

Errore Chiave Non Valida

Error: Invalid API key

Soluzioni:

1. Verificare che la chiave sia copiata correttamente (incluso il ul_ prefisso)
2. Controlla che la chiave non sia stata revocata
3. Conferma che la variabile d'ambiente sia impostata
4. Assicurati di utilizzare ultralytics>=8.4.14

Autorizzazione Negata

Error: Permission denied for this operation

Soluzioni:

1. Verificare di essere il proprietario della risorsa o di avere l'accesso appropriato all'area di lavoro
2. Verifica che la chiave appartenga allo spazio di lavoro corretto.
3. Crea una nuova chiave se necessario

Frequenza limitata

Error: Rate limit exceeded

Soluzioni:

1. Riduci la frequenza delle richieste — consulta la tabella dei limiti di frequenza per i limiti per endpoint
2. Implementare il backoff esponenziale utilizzando il Retry-After header
3. Utilizzare un endpoint dedicato per un throughput di inferenza illimitato

FAQ

Quante chiavi posso creare?

Non c'è un limite rigido al numero di chiavi API. Creane quante ne servono per diverse applicazioni e ambienti.

Le chiavi scadono?

Le chiavi non scadono automaticamente. Rimangono valide fino alla revoca. Considera di implementare la rotazione per motivi di sicurezza.

Posso visualizzare la mia chiave dopo la creazione?

Sì, i valori completi delle chiavi sono visibili nell'elenco delle chiavi su Settings > Profile. La Piattaforma decrittografa e visualizza le tue chiavi in modo che tu possa copiarle in qualsiasi momento.

Le chiavi sono specifiche per regione?

Le chiavi funzionano tra le regioni ma accedono ai dati solo nella regione del tuo account.

Posso condividere le chiavi con i membri del team?

Buona pratica: Ogni membro del team dovrebbe creare la propria chiave. Per gli spazi di lavoro di team, ogni membro con ruolo Editor o superiore può creare chiavi con ambito limitato a quello spazio di lavoro.

📅 Creato 2 mesi fa ✏️ Aggiornato 5 giorni fa

Commenti