Nouvelle API RESTful de diffusion en direct pour les diffuseurs et les développeurs

New RESTful Live Streaming API for Broadcasters and Developers

Chez Dacast, nous sommes fiers d’annoncer officiellement que la version 2 de notre API Live Streaming est disponible. Cette API JSON RESTful a été conçue spécifiquement pour une intégration rapide et facile de toutes les fonctionnalités de la plateforme de service de streaming Dacast dans une grande variété d’applications vidéo en nuage, de services et de flux de travail de médias numériques.

Dans ce blog, nous souhaitons vous présenter le concept d’API, expliquer ce que vous pouvez désormais construire en utilisant notre API de diffusion en direct et présenter certaines des commandes de base que vous pouvez utiliser pour manipuler vos données à l’aide de cet outil. À la fin de ce billet, vous trouverez un lien vers notre documentation et d’autres ressources d’apprentissage.

Qu’est-ce qu’une API ?

API est l’abréviation de Application Programming Interface (interface de programmation d’applications). Une interface de programmation d’application est un moyen simplifié d’envoyer et de récupérer des données à partir d’un système informatique complexe –dans ce cas, le réseau d’hébergement vidéo et la plateforme de gestion de Dacast.

Une API fonctionne grâce à un système d’opérations, d’entrées, de sorties et de types de données sous-jacents qui sont normalisés sur la plateforme. Cela crée un “langage” commun (notre API utilise le format JSON) utilisant des commandes et des URL prévisibles que les programmeurs peuvent utiliser pour créer leurs propres méthodes d’interaction avec leurs données qui sont stockées sur un autre réseau au sein d’une plateforme propriétaire.

Les données au sein de la plateforme changeront, et Dacast pourra continuer à ajouter de nouvelles fonctionnalités et à faire évoluer ses technologies, mais le langage de l’API restera le même, avec un ou deux nouveaux appels ajoutés pour permettre aux utilisateurs d’exploiter de nouvelles capacités sans perturber les applications et les services construits sur l’API existante.

En pratique, une API permet aux utilisateurs de Dacast de personnaliser presque tous les aspects de l’expérience de visualisation et de mettre en place manuellement leurs propres méthodes de téléchargement, de renommage, de déplacement, de marquage, d’accès et de gestion du contenu sur la plateforme Dacast.

La nouvelle API de diffusion en direct de Dacast : Version 2

La version 2 de l’API Live Streaming de Dacast développe les fonctionnalités fournies par la version 1, de sorte que nos utilisateurs chevronnés et nos clients professionnels sont désormais en mesure d’utiliser toutes les fonctionnalités de Dacast sans avoir à se connecter à leurs comptes Dacast. Cette version donne à nos utilisateurs encore plus de pouvoir sur leur contenu et, selon nous, constitue une raison convaincante d’envisager l’utilisation de notre API de diffusion en direct.

Les entreprises et les organisations à la recherche d’un contrôle total et d’une personnalisation peuvent aller jusqu’à créer leur propre plateforme de streaming vidéo basée sur le backend de Dacast. À plus petite échelle, chacun peut utiliser notre API Live Streaming pour accéder facilement aux données, extraire des informations de son compte, télécharger et modifier des informations via un appareil distant, coder une application, etc.

Caractéristiques de l’API de diffusion en direct de Dacast

Les fonctionnalités incluses dans l’API de diffusion en direct de Dacast sont trop nombreuses pour être énumérées dans leur intégralité, mais en voici quelques-unes.

Fichiers et canaux d’écriture

Notre API de diffusion en direct vous permet de publier des vidéos sur votre chaîne de diffusion en direct directement dans vos propres applications ou plateformes. Cela vous permet de créer un flux de travail rationalisé qui peut coexister avec les plates-formes logicielles actuelles. Vous pouvez également créer et télécharger des vidéos pour une visualisation à la demande dans l’API de diffusion en direct, sans avoir besoin d’utiliser le site web de Dacast.

Lire les fichiers et les canaux

De même, l’API de diffusion en direct permet de contrôler la visualisation de votre contenu. Cela vous permet de programmer des interfaces personnalisées pour afficher votre vidéo sur des appareils uniques et dans des situations autrement inaccessibles. Vous pouvez, par exemple, coder votre propre application mobile qui peut être distribuée aux utilisateurs en tant que centre de visionnage de votre contenu à la demande et en direct dans un environnement contrôlé par la marque.

Vous pouvez également utiliser les commandes de lecture pour télécharger facilement des informations à partir de votre compte, par exemple en créant une liste de toutes les vidéos classées en fonction de leur durée ou de la date à laquelle elles ont été téléchargées.

Créer de nouveaux comptes (et administrateurs)

Grâce à notre API de diffusion en direct, même les tâches de gestion les plus banales, comme la distribution et le contrôle de l’accès à votre compte, ne nécessitent pas l’utilisation directe de la plateforme Dacast. Au lieu de cela, vous pouvez utiliser des applications personnalisées ou des terminaux de ligne de commande pour rationaliser vos flux de travail. Il s’agit également de gérer le contrôle de l’accès aux comptes et de fournir des informations d’identification aux nouveaux utilisateurs.

Fonctionnalité pour les revendeurs

Les revendeurs à valeur ajoutée (VAR) de Dacast achètent des plans d’accès à notre plateforme d’hébergement vidéo et la revendent ensuite en petites quantités à d’autres clients. Grâce à notre API Live Streaming, les VAR peuvent désormais créer leur propre plateforme de streaming vidéo en direct pour leurs clients. Cette plateforme peut être marquée comme vous le souhaitez, sans qu’il soit nécessaire d’utiliser la plateforme, le nom ou le logo de Dacast, et présentera toutes les fonctionnalités de Dacast qui sont disponibles pour nos utilisateurs.

Accès à la monétisation en lecture et en écriture

Vous pouvez également utiliser notre API de diffusion en direct pour contrôler les paramètres de monétisation. Par exemple, configurez la monétisation des nouvelles vidéos à la volée, au fur et à mesure que les émissions sont diffusées et que les vidéos sont téléchargées. Vous pouvez également accéder aux données de monétisation et modifier les paramètres des vidéos existantes à partir de l’API de diffusion en direct.

Accès à l’analyse

Dacast maintient un ensemble d’analyses détaillées pour le suivi des informations et des performances concernant les personnes qui consultent votre contenu, pendant combien de temps, à partir de quels endroits, etc.

L’API permet d’accéder aux données analytiques sous forme brute, ce qui vous permet de coder vos propres affichages personnalisés, de sélectionner les mesures les plus pertinentes et de recueillir les informations les plus importantes pour vos activités. Ces données peuvent être essentielles pour prendre des décisions éclairées en matière de marketing et pour adapter votre approche du contenu futur.

Publier sur un portail

Notre API de diffusion en direct vous permet de créer facilement vos propres portails vidéo ou audio pour un accès personnalisé à votre contenu, sans qu’il soit nécessaire d’utiliser un lecteur vidéo ou une infrastructure Dacast. Au lieu de cela, il vous suffit de transférer votre contenu dans votre portail personnalisé en fonction de vos besoins.

Accès au transcodage de fichiers

L’un des éléments les plus puissants du système Dacast est la possibilité de transcoder les fichiers dans le nuage dans les formats nécessaires pour atteindre le public visé. La nouvelle API de diffusion en direct offre un accès direct à la puissante architecture de serveur qui sous-tend ce processus, ce qui vous permet de mettre en œuvre des paramètres de contenu personnalisés et de fournir les fichiers multimédias précis de votre choix à vos téléspectateurs.

Contrôles des listes de lecture et des paquets

La plateforme de Dacast permet de créer des listes de lecture de contenu qui peuvent être intégrées et qui seront lues de manière séquentielle. Les packs, qui sont généralement utilisés pour créer une collection de contenus pouvant être monétisés moyennant un abonnement unique ou un paiement à la séance, constituent une autre option pour regrouper des contenus.

Ces deux options de regroupement peuvent être créées, modifiées et contrôlées via la nouvelle version 2 de l’API de diffusion en direct.

Amélioration des performances

Les améliorations apportées à notre API de diffusion en direct ont également stimulé les performances de la plateforme en général. Désormais, les demandes de données et les opérations seront exécutées plus efficacement et plus rapidement, ce qui se traduira par une expérience utilisateur plus rapide et une productivité accrue.

Lecteurs vidéo personnalisés

La nouvelle API de diffusion en direct permet également un accès complet à l’API du lecteur vidéo Dacast, ce qui vous permet de personnaliser notre lecteur vidéo en marque blanche ou même de développer votre propre solution pour qu’elle corresponde à la marque, au style ou aux besoins de votre organisation en termes de fonctionnalités. Les lecteurs personnalisés peuvent prendre en charge les vidéos HTML5 ou Flash, les systèmes DRM avancés et optimiser le référencement à l’aide de métadonnées et de balises.

Les lecteurs vidéo personnalisés permettent également l’intégration de plateformes tierces pour la capture d’e-mails, l’incitation à l’action, la publicité et d’autres formes de monétisation, ainsi que des plateformes d’analyse telles que Google Analytics, ComScore et d’autres.

Architecture de l’API de diffusion en direct de Dacast

Les API modernes dédiées à l’édition et au contrôle du contenu situé sur un autre réseau utilisent souvent une norme REST (Representational State Transfer) pour garantir que les données sont communiquées de manière robuste entre le client et la plateforme.

La nouvelle API de diffusion en direct de Dacast est de type RESTful, ce qui signifie qu’il est possible d’y accéder à partir de n’importe quel serveur ou application client de votre choix. Cela signifie également que vous pouvez utiliser le langage de programmation de votre choix pour interagir avec l’API. Tout ce qui est important, c’est la capacité de faire des requêtes HTTP GET et POST et de traiter les réponses au format JSON.

Principes de base de l’API

Les commandes de l’API Live Streaming de Dacast sont réparties en neuf catégories qui couvrent toutes les fonctionnalités de Dacast. Ces catégories sont les suivantes

  1. Vidéo à la demande
  2. Chaîne en direct
  3. Liste de lecture
  4. Paquet
  5. Préférences
  6. Analyse
  7. Informations sur le compte
  8. Information du public
  9. Liste des erreurs

Chacune de ces catégories contient une liste complète de commandes permettant de manipuler et d’interagir avec la plate-forme Dacast. Dans chaque catégorie, des sous-catégories permettent de délimiter les commandes qui affectent telle ou telle partie de votre activité. Pour chaque commande, des paramètres vous permettent de personnaliser vos requêtes.

Commandes de la chaîne en direct

Par exemple, la catégorie “Chaîne en direct” comprend quatre sous-catégories. Il s’agit de

  • 2.1 – Opérations de base
  • 2.2 – Opérations tarifaires
  • 2.3 – Opérations sur les coupons
  • 2.4 – Analytics Operations (qui contient des opérations dépréciées qui ne sont plus utilisées dans la version 2 de notre API Live Streaming)

Chacune de ces catégories comprend une liste d’opérations conçues pour modifier et interagir avec vos données. Par exemple, voici une liste des commandes figurant à la section 2.1 – Opérations de base.

  • GET /v2/channel (Liste des canaux de votre compte)
  • POST /v2/channel (Créer un nouveau canal)
  • DELETE /v2/channel/{channel_id} (Supprimer un canal)
  • GET /v2/channel/{channel_id} (Obtenir les détails du canal)
  • PUT /v2/channel/{channel_id} (Mise à jour des détails du canal)
  • GET /v2/channel/{channel_id}/embed/{embed_type} (Obtenir le code d’intégration de la chaîne)
  • DELETE /v2/channel/{channel_id}/splash (Supprimer l’écran d’accueil personnalisé)
  • POST /v2/channel/{channel_id}/splash (Chargement d’un écran d’accueil personnalisé)
  • GET /v2/channel/{channel_id}/startstream (Obtenir les détails du canal)
  • DELETE /v2/channel/{channel_id}/thumbnail (Supprimer la vignette personnalisée)
  • POST /v2/channel/{channel_id}/thumbnail (Télécharger une vignette personnalisée)
  • POST /v2/channel/{channel_id}/xml (Obtenir le canal XML)

Paramètres de commande

La plupart de ces commandes disposent également d’un certain nombre de paramètres différents qui peuvent être utilisés pour renvoyer les données dans un ordre différent ou pour personnaliser les informations d’autres manières.

Commande GET Channel

Par exemple, la première commande renvoie une liste de toutes les chaînes en direct de votre compte. Pour envoyer cet opérateur à Dacast, il suffit de saisir une URL dans votre navigateur (ou dans un terminal ou une application connectée au web). L’URL complète de cette commande de base serait : http://api.dacast.com/v2/channel?apikey={your_apikey}.

Cette commande peut être personnalisée à l’aide de trois paramètres. Le premier, “tri”, vous permet de choisir un ordre croissant ou décroissant pour classer vos résultats. Le deuxième paramètre, “order by”, choisit la métrique selon laquelle les résultats seront triés. Par exemple, vous pouvez trier par titre de A à Z avec les paramètres suivants : http://api.dacast.com/v2/channel?apikey={your_apikey}&order_by=title&sort=DSC.

Le troisième paramètre est le filtre, qui (comme son nom l’indique) vous permet de filtrer en fonction d’attributs plus spécifiques. Par exemple, vous pouvez filtrer votre liste pour qu’elle ne contienne que les flux ayant un certain nom, une certaine date de création, un certain paramètre de paiement à l’acte, une certaine durée, etc. Ce paramètre est ajouté à l’aide d’une série de balises dont la liste complète figure dans la documentation mentionnée ci-dessous.

Commande PUT Channel Details

Autre exemple, la commande de mise à jour des détails d’un canal contient un certain nombre de paramètres permettant de modifier tous les paramètres relatifs à un canal donné. (Note : pour modifier ces paramètres, vous aurez besoin du numéro d’identification du canal, qui peut être trouvé en utilisant la première commande GET Channel).

Les paramètres qui peuvent être personnalisés à l’aide de cette commande sont les suivants :

  • Titre de la chaîne
  • Description
  • Catégorie
  • Statut en ligne (activer ou désactiver la chaîne)
  • Compteur en direct (permet d’activer ou de désactiver un compteur affichant le nombre de personnes qui regardent votre chaîne, et de définir le seuil d’affichage de ce compteur)
  • Google Analytics (activer ou désactiver le suivi Google Analytics pour ce canal)
  • Autoplay (activer ou désactiver)
  • Publier sur Dacast (activer ou désactiver la publication sur le portail Dacast)
  • Page vidéo externe (l’URL de la page web sur laquelle vous publierez votre chaîne)
  • Mot de passe (permet de protéger votre chaîne par un mot de passe)
  • Referrers ID (code d’identification de la liste des référents à appliquer à ce canal)
  • Countries ID (code d’identification de la liste des pays que vous souhaitez voir accéder à votre chaîne)
  • Theme ID (appliquer un thème personnalisé au lecteur vidéo Dacast)
  • Player Size ID (permet de définir la taille de la fenêtre du lecteur vidéo à l’aide de préréglages communs)
  • Largeur et hauteur du lecteur (permet de personnaliser la taille du lecteur vidéo)
  • NoFrame Security (activer ou désactiver la sécurité du cadre)
  • Splashscreen ID (permet de définir des écrans de démarrage personnalisés ou de choisir les valeurs par défaut de Dacast)
  • ID de la vignette (permet de définir des vignettes personnalisées ou de choisir les valeurs par défaut de Dacast)
  • Données personnalisées (un champ qui peut être utilisé pour stocker et récupérer des métadonnées)

Ressources API

Pour en savoir plus sur la nouvelle API Live Streaming de Dacast, vous pouvez consulter notre documentation complète qui se trouve ici. Si vous êtes déjà connecté à votre compte Dacast, cette ressource se trouve également dans le menu Aide.

Pour générer une clé API, qui est nécessaire pour utiliser l’API, vous pouvez visiter le panneau de préférence Clé API dans le back-office Dacast. Une fois que vous avez généré une clé API, visitez la page de documentation et saisissez-la dans le champ situé en haut de la page.

À ce stade, la page de documentation peut être utilisée comme un bac à sable pour tester diverses commandes d’API et apprendre la plate-forme. Pour tester une commande donnée à l’aide de votre compte, cliquez sur une opération donnée, puis sur l’onglet “sandbox” en haut de la documentation de la commande. Sur cette page, vous pouvez tester la commande sans affecter les données de votre compte.

Premiers pas avec l’API de diffusion en direct de Dacast

Nous sommes très enthousiastes à propos de la nouvelle API de diffusion en direct de Dacast, et nous savons que beaucoup de nos clients le sont aussi. Nous pensons qu’il s’agit d’un nouveau moyen puissant de contrôler vos données et qu’il devrait permettre à nos utilisateurs d’exporter notre technologie dans leur propre plateforme. Si vous avez un projet passionnant d’utilisation de l’API Live Streaming, contactez-nous. Nous serions ravis d’en savoir plus et éventuellement de publier l’histoire sur notre blog !

Si vous êtes déjà utilisateur de Dacast et que vous rencontrez des problèmes avec notre API de diffusion en direct, veuillez envoyer un courriel à support@dacast.com en indiquant votre clé API, l’appel API que vous avez effectué, les réponses ou les messages d’erreur que vous avez reçus et l’heure à laquelle vous avez rencontré l’erreur. Nous vous répondrons dans les plus brefs délais !

Merci de votre lecture !

L'avenir de la diffusion vidéo en direct

Max Wilbert

Max Wilbert is a passionate writer, live streaming practitioner, and has strong expertise in the video streaming industry.