Référence de l’API
Chaque route de l’API, générée à partir de la même spécification que celle utilisée par le serveur. Base : https://api.vidoum.com.
Les erreurs communes à toutes les routes sont décrites dans Erreurs et limites. Le document OpenAPI 3.1 complet est servi par l’API : GET /v1/openapi.json.
Organisation
Téléversements
- POST/v1/uploadsCréer une vidéo et sa session d’envoi (envoi unique ou en plusieurs parties)
- GET/v1/uploads/{id}État d’un envoi ; parties reçues pour reprendre un envoi en plusieurs parties
- POST/v1/uploads/{id}/completeVérifier le fichier et placer la vidéo dans la file d’encodage
- POST/v1/uploads/{id}/partsURL signées pour 100 parties au plus d’un envoi en plusieurs parties
- POST/v1/uploads/{id}/cancelAnnuler un envoi ou une vidéo en attente d’encodage (idempotent)
Vidéos
- GET/v1/videosLister les vidéos, des plus récentes aux plus anciennes (pagination par curseur)
- GET/v1/videos/{id}Une vidéo, avec ses qualités et ses sous-titres
- PATCH/v1/videos/{id}Modifier le titre, la description ou la référence externe
- DELETE/v1/videos/{id}Supprimer une vidéo et ses fichiers (les copies en cache sont bloquées d’abord)
- POST/v1/videos/{id}/retryRelancer l’encodage d’une vidéo en échec
- POST/v1/videos/{id}/completeAlias de compatibilité de POST /v1/uploads/{id}/complete pour l’envoi en cours de la vidéo
- GET/v1/videos/{id}/thumbnailRedirection (302) vers une URL de la miniature valable 10 minutes ; 404 si la lecture est désactivée
- POST/v1/videos/{id}/captionsURL d’envoi signée pour un fichier de sous-titres WebVTT (vidéos prêtes)
- DELETE/v1/videos/{id}/captions/{language}Supprimer un fichier de sous-titres
Lecture
- POST/v1/playback-tokensLien de lecture signé pour un apprenant (après avoir vérifié ses droits)
- GET/v1/playback-sessionsSessions de lecture avec la progression des apprenants, de la plus récente à la plus ancienne (synchronisation LMS)
- GET/v1/playback-sessions/{id}Une session de lecture et la progression de l’apprenant
- POST/v1/playback-eventsÉvénements du lecteur, authentifiés par le lien de lecture (envoyés par le lecteur Vidoum, pas par votre serveur)
- POST/v1/playback-sessions/{id}/revokeRévoquer un lien de lecture avant son expiration (effectif en 2 minutes environ)
Webhooks
- GET/v1/webhooksLister les webhooks
- POST/v1/webhooksCréer un webhook (le secret de signature n’est renvoyé qu’une fois)
- GET/v1/webhooks/{id}Un webhook
- PATCH/v1/webhooks/{id}Modifier l’URL, les événements, la description, ou activer / désactiver
- DELETE/v1/webhooks/{id}Supprimer un webhook
- POST/v1/webhooks/{id}/rotate-secretNouveau secret de signature ; l’ancien signe encore pendant 24 h
- POST/v1/webhooks/{id}/testEnvoyer un événement webhook.test à ce point d’accès
- GET/v1/webhooks/{id}/deliveriesJournal des envois (30 jours), du plus récent au plus ancien
- POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverRenvoyer un événement
Consommation
Clés API
Système
Objets
Organization, Usage, Video, Upload, PlaybackToken, PlaybackSession, Webhook, WebhookDelivery, VideoUsage, ApiKeyRotation.