Authentification
Obtenir une Clé API
Tu peux créer une Clé API sur la page Intégrations API dans l’interface d’administration Ignite. Tu dois avoir un rôle admin pour accéder à cette page.
Lorsque tu crées une clé, choisis ses permissions et un périmètre de catégories optionnel.
Permissions
Les permissions d’une Clé API sont accordées par ressource. Active uniquement les actions dont ton intégration a besoin.
| Ressource | Actions disponibles |
|---|---|
| Vidéos | read, create, update, delete, publish |
| Événements live | read, create, update, delete, publish |
| Tags | create, update, delete |
| Catégories | create, update, delete |
| Analytics | read |
L’accès en lecture aux catégories, aux tags et aux presets de lecteur est toujours accordé. Tu n’as pas besoin de l’activer. Les Clés API ne peuvent pas créer, mettre à jour ni supprimer de presets de lecteur.
publish est distinct de create et update. visibility: public n’est enregistré que lorsque la clé a videos.publish. Sans cela, la création enregistre private. Un PATCH qui définit visibility est accepté, le champ reste inchangé et la réponse reste 200. Aucun des deux cas ne renvoie 403.
Les endpoints Analytics nécessitent analytics.read. La permission read sur les vidéos ne suffit pas. Voir Analytics.
Les Clés API ne peuvent pas gérer les membres, les webhooks, les autres intégrations API ni les paramètres du compte.
Périmètre de catégories
Tu peux limiter une Clé API à une ou plusieurs catégories. Le périmètre inclut ces catégories et leurs sous-catégories. Il filtre les lectures et les écritures de vidéos, ainsi que les lectures, les mises à jour et les suppressions de catégories. Une clé avec périmètre ne peut pas supprimer une catégorie qui est l’une de ses ancres de périmètre. Si tu crées une vidéo sans envoyer de catégories, les catégories du périmètre lui sont assignées, jusqu’à 10. Si tu laisses le champ vide, la clé peut accéder à toutes les catégories de l’espace de travail.
Le périmètre de catégories ne limite pas les tags ni les événements live. Il s’applique aux appels Analytics par vidéo.
Utiliser une Clé API
Passe ta Clé API comme Jeton Bearer dans l’en-tête Authorization de ta requête.
CURL
curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_API_KEY"Clé API manquante ou invalide
Une Clé API manquante ou invalide renvoie 403 :
{
"errors": [
{
"message": "You are not allowed to perform this action"
}
]
}Formes des réponses d’erreur
Les endpoints de collection (vidéos, catégories, tags et presets de lecteur) renvoient les erreurs Payload sous la forme { errors: [{ message }] }.
Les endpoints personnalisés (téléchargement, remplacement, miniatures, Text tracks, Multipart Upload et routes IA) renvoient { error, message? }. message est omis pour certaines erreurs. Un échec de permission sur ces routes renvoie 403.
{
"error": "not_found"
}{
"error": "invalid_video_id"
}Un champ qui échoue à la validation sur un endpoint de collection renvoie 400 avec la forme d’erreur Payload.
Le GET d’une vidéo, d’une catégorie ou d’un tag manquant renvoie 404 { errors: [{ message: "Not Found" }] }. Le PATCH ou le DELETE d’un id manquant renvoie 403 avec l’erreur Payload ci-dessus. La réponse est la même lorsque le document est manquant et lorsque la clé n’est pas autorisée à le voir.