Documentation

Vidoum héberge, encode et diffuse les vidéos de votre plateforme. Votre serveur parle à l’API ; le navigateur envoie les fichiers et affiche le lecteur. Cette page résume l’intégration en six étapes.

Le principe

  • Votre plateforme garde ses utilisateurs. Vidoum ne connaît ni vos comptes ni vos inscriptions : c’est votre serveur qui décide qui peut regarder une vidéo.
  • La clé API reste sur votre serveur. Elle ne doit jamais apparaître dans le code d’une page web ou d’une application mobile.
  • Les fichiers ne passent pas par vos serveurs. Le navigateur du formateur les envoie directement à Vidoum avec une URL signée.

URL de base : https://api.vidoum.com/v1. Toutes les requêtes et réponses sont en JSON.

Démarrage rapide

  1. Créer une clé dans l’espace client (Développeurs) avec les permissions nécessaires, et la ranger dans la configuration secrète de votre serveur. Voir Authentification.
  2. Créer l’envoi : votre serveur appelle POST /v1/uploads pour un formateur autorisé et renvoie l’URL d’envoi au navigateur.
  3. Envoyer le fichier : le navigateur fait un PUT sur cette URL (ou envoie le fichier en plusieurs parties au-delà de 5 Go), puis votre serveur appelle POST /v1/uploads/{id}/complete. Voir Téléversement.
  4. Attendre l’encodage : le webhook video.ready vous prévient (ou interrogez GET /v1/videos/{id}). Voir Webhooks.
  5. Vérifier l’accès de l’apprenant avec vos propres règles (inscription, paiement, rôle).
  6. Afficher le lecteur : votre serveur demande un lien avec POST /v1/playback-tokens et la page l’affiche dans une iframe. Voir Lecture et lecteur.
Le flux complet
1. POST /v1/uploads                → video + upload.url
2. PUT  upload.url  (navigateur)    → fichier envoyé directement
3. POST /v1/uploads/{id}/complete   → vidéo "queued"
4. webhook video.ready              → vidéo "ready"
5. votre serveur vérifie l’accès de l’apprenant
6. POST /v1/playback-tokens         → embedUrl → <iframe src="embedUrl">

Premier appel

Vérifiez que votre clé fonctionne :

Terminal
curl https://api.vidoum.com/v1/organizations/me \
  -H "Authorization: Bearer $VIDOUM_API_KEY"

→ { "organization": { "id": "…", "name": "…", "status": "active", "limits": { … } } }

Pour aller plus loin

  • Référence de l’API : chaque route, ses paramètres et ses réponses.
  • SDK Node.js : les mêmes appels, avec types, nouvelles tentatives et idempotence automatiques.
  • Le document OpenAPI 3.1, lisible par vos outils (génération de clients, tests), est servi par l’API : GET https://api.vidoum.com/v1/openapi.json.