Autenticazione
Ottenere una chiave API
Puoi creare una chiave API nella pagina Integrazioni API nell’interfaccia Ignite Admin. Devi avere un ruolo admin per accedere a questa pagina.
Quando crei una chiave, scegli i suoi permessi e un eventuale ambito di categorie.
Permessi
I permessi della chiave API sono concessi per risorsa. Abilita solo le azioni di cui la tua integrazione ha bisogno.
| Risorsa | Azioni disponibili |
|---|---|
| Video | read, create, update, delete, publish |
| Eventi live | read, create, update, delete, publish |
| Tags | create, update, delete |
| Categorie | create, update, delete |
| Analytics | read |
L’accesso in lettura a categories, tags e preset del player è sempre concesso. Non devi abilitarlo. Le chiavi API non possono creare, aggiornare o eliminare preset del player.
publish è separato da create e update. visibility: public viene salvato solo quando la chiave ha videos.publish. Senza quel permesso, la creazione salva private. Un PATCH che imposta visibility viene accettato, il campo resta invariato e la risposta resta 200. Nessuno dei due casi restituisce 403.
Gli endpoint Analytics richiedono analytics.read. Il solo read sui video non basta. Vedi Analytics.
Le chiavi API non possono gestire membri, webhook, altre integrazioni API o le impostazioni dell’account.
Ambito di categorie
Puoi limitare una chiave API a una o più categorie. L’ambito include quelle categorie e le loro sottocategorie. L’ambito filtra le letture e le scritture dei video e le letture, gli aggiornamenti e le eliminazioni delle categorie. Una chiave con ambito non può eliminare una categoria che è uno dei suoi ancoraggi di ambito. Se crei un video e non invii categorie, vengono assegnate le categorie dell’ambito, fino a 10. Se lasci il campo vuoto, la chiave può accedere a ogni categoria del workspace.
L’ambito di categorie non limita i tag né gli eventi live. Si applica alle chiamate analytics per singolo video.
Usare una chiave API
Passa la tua chiave API come Token Bearer nell’header Authorization della tua richiesta.
CURL
curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_API_KEY"Chiave API mancante o non valida
Una chiave API mancante o non valida restituisce 403:
{
"errors": [
{
"message": "You are not allowed to perform this action"
}
]
}Forme delle risposte di errore
Gli endpoint di collection (video, categorie, tag e preset del player) restituiscono gli errori Payload come { errors: [{ message }] }.
Gli endpoint custom (upload, replace, miniature, Text tracks, multipart upload e route AI) restituiscono { error, message? }. message viene omesso in alcuni errori. Un errore di permesso su quelle route restituisce 403.
{
"error": "not_found"
}{
"error": "invalid_video_id"
}Un campo che non supera la validazione su un endpoint di collection restituisce 400 con la forma di errore Payload.
Il GET di un video, di una categoria o di un tag mancante restituisce 404 { errors: [{ message: "Not Found" }] }. Il PATCH o il DELETE di un id mancante restituisce 403 con l’errore Payload qui sopra. La risposta è la stessa quando il documento manca e quando la chiave non è autorizzata a vederlo.