Chiavi API
Le chiavi API Ultralytics consentono un accesso programmatico sicuro per la formazione remota, l'inferenza e l'automazione. Crea chiavi con ambito specifico e autorizzazioni specifiche per diversi casi d'uso.
Crea chiave API
Crea una nuova chiave API:
- Vai su Impostazioni > Chiavi API
- Fai clic su Crea chiave
- Inserisci un nome per la chiave
- Seleziona gli ambiti di autorizzazione
- Clicca su Crea
Nome chiave
Assegna alla tua chiave un nome descrittivo:
training-server- Per macchine di addestramento a distanzaci-pipeline- Per l'integrazione CI/CDmobile-app- Per applicazioni mobili
Ambito delle autorizzazioni
Selezionare gli ambiti per limitare le autorizzazioni chiave:
| Ambito | Autorizzazioni |
|---|---|
| addestramento | Inizia l'allenamento, trasmetti le metriche |
| models | Carica, scarica, elimina modelli |
| datasets | Accedere e modificare i set di dati |
| leggere | Accesso in sola lettura a tutte le risorse |
| scrivere | Accesso completo in scrittura |
| amministratore | Gestione dell'account (da usare con cautela) |
Privilegio minimo
Crea chiavi con solo le autorizzazioni necessarie. Utilizza chiavi separate per applicazioni diverse.
Visualizzazione tasti
Dopo la creazione, la chiave viene visualizzata una sola volta:
Copia la tua chiave
La chiave completa viene mostrata solo una volta. Copiala immediatamente e conservala in un luogo sicuro. Non potrai recuperarla in un secondo momento.
Formato chiave
Le chiavi API seguono questo formato:
ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
- Prefisso:
ul_identifica Ultralytics - Corpo: 40 caratteri esadecimali casuali
- Totale: 43 caratteri
Utilizzo delle chiavi API
Variabile d'ambiente
Imposta la tua chiave come variabile d'ambiente:
export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
Nel codice
Utilizza la chiave nei tuoi 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"
Intestazioni HTTP
Includere la chiave nelle richieste API:
curl -H "Authorization: Bearer ul_your_key_here" \
https://platform.ultralytics.com/api/...
Formazione a distanza
Abilita lo streaming delle metriche con la tua chiave.
Requisiti relativi alla versione del pacchetto
L'integrazione con la piattaforma richiede ultralytics>= 8.4.0. Le versioni precedenti NON funzionano con la piattaforma.
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
Gestisci chiavi
Tasti di visualizzazione
Tutte le chiavi sono elencate in Impostazioni > Chiavi API:
| Colonna | Descrizione |
|---|---|
| Nome | Identificatore chiave |
| Ambito di applicazione | Autorizzazioni assegnate |
| Creato | Data di creazione |
| Ultimo utilizzo | Utilizzo più recente |
Revoca chiave
Revoca una chiave compromessa o non più necessaria:
- Clicca sul menu della chiave
- Seleziona Revoca
- Conferma revoca
Effetto immediato
La revoca è immediata. Qualsiasi applicazione che utilizza la chiave smetterà di funzionare.
Rigenera chiave
Se una chiave viene compromessa:
- Crea una nuova chiave con gli stessi ambiti
- Aggiorna le tue applicazioni
- Revoca la vecchia chiave
Migliori pratiche di sicurezza
Fai
- Memorizza le chiavi nelle variabili d'ambiente
- Utilizza chiavi separate per ambienti diversi
- Revoca tempestivamente le chiavi inutilizzate
- Utilizzare gli ambiti minimi richiesti
- Ruotare periodicamente le chiavi
Non
- Inserisci le chiavi nel controllo di versione
- Condividi le chiavi tra le applicazioni
- Utilizzo non necessario dell'ambito amministrativo
- Registra le chiavi nell'output dell'applicazione
- Incorporare le chiavi nel codice lato client
Rotazione chiave
Ruotare periodicamente le chiavi per motivi di sicurezza:
- Crea una nuova chiave con gli stessi ambiti
- Aggiornare le applicazioni per utilizzare la nuova chiave
- Verificare che le applicazioni funzionino correttamente
- Revoca vecchia chiave
Programma di rotazione
Considerare la possibilità di ruotare le chiavi ogni 90 giorni per le applicazioni sensibili.
Risoluzione dei problemi
Errore chiave non valida
Error: Invalid API key
Soluzioni:
- Verificare che la chiave sia stata copiata correttamente
- Verifica che la chiave non sia stata revocata
- Assicurarsi che la chiave abbia gli ambiti richiesti
- Verificare che la variabile di ambiente sia impostata
Autorizzazione negata
Error: Permission denied for this operation
Soluzioni:
- Controllare che gli ambiti delle chiavi includano le autorizzazioni richieste
- Verifica di essere il proprietario della risorsa
- Crea una nuova chiave con gli ambiti corretti
Velocità limitata
Error: Rate limit exceeded
Soluzioni:
- Ridurre la frequenza delle richieste
- Implementare il backoff esponenziale
- Contatta l'assistenza per aumentare il limite
FAQ
Quante chiavi posso creare?
Non ci sono limiti rigidi per le chiavi API. Creane quante ne servono per le diverse applicazioni e ambienti.
Le chiavi hanno una scadenza?
Le chiavi non scadono automaticamente. Rimangono valide fino alla loro revoca. Per motivi di sicurezza, è consigliabile implementare una rotazione periodica.
Posso vedere la mia chiave dopo averla creata?
No, la chiave completa viene mostrata solo una volta al momento della creazione. Se la perdi, crea una nuova chiave e revoca quella vecchia.
Le chiavi sono specifiche per regione?
Le chiavi funzionano in tutte le regioni, ma consentono di accedere solo ai dati nella regione del tuo account.
Posso condividere le chiavi con i membri del team?
Pratica migliore: chiedere a ciascun membro del team di creare la propria chiave. Ciò consente di:
- Monitoraggio delle attività individuali
- Revoca selettiva
- Controllo adeguato degli accessi