assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Présentation : API de gestion des lecteurs

    La gestion des joueurs désigne la création, l'édition et la gestion des joueurs en tant que ressource pour les éditeurs. La gestion du lecteur est réalisée par une API REST côté serveur qui permet à ses consommateurs de créer, configurer, prévisualiser et publier des instances de lecteur.
     

    Introduction

    La création et la mise à jour des joueurs se font selon une approche en deux phases. Plutôt que d'appliquer automatiquement toutes les modifications aux joueurs de production, les modifications sont séparées en prévisualisation et publiées. Vous pouvez désormais effectuer toutes les mises à jour que vous souhaitez sur votre lecteur de prévisualisation sans affecter ce que vos utilisateurs finaux voient. Vous pouvez choisir de publier les modifications quand vous le souhaitez.

    L'API Player Management permet à un utilisateur de :

    1. créer un lecteur ;
    2. Afficher les paramètres d'un lecteur
    3. Modifier les paramètres d'un lecteur
    4. Liste de tous les joueurs associés à l'éditeur
    5. Publier un lecteur pour le mettre à la disposition des utilisateurs

    Voir également la référence de l'API.

    URL de base

    L'URL de base de l'API est :

        https://players.api.brightcove.com/v2

    Introduction

    Le système de gestion des joueurs se compose de trois objets clés. Ils sont le modèle par défaut, les joueurs et les joueurs enfants.

    Modèle par défaut Brightcove - Le modèle est un ensemble de fichiers et de paramètres utilisés comme base pour créer les expériences de visualisation présentées aux utilisateurs, et la base pour tous les joueurs créés. Ces fichiers sont éventuellement compilés avec des paramètres personnalisés du lecteur et aboutissent au code réel qui est chargé dans le navigateur (le lecteur). Il n'y a actuellement qu'un seul modèle qui est utilisé à l'échelle du système. En tant que tel, il n'y a pas de visibilité dans le modèle via l'API.

    Joueurs - Les joueurs sont des paramètres spécifiques au client qui capturent des informations générales et des personnalisations à appliquer au modèle. Ces paramètres sont envoyés à l'API et les résultats d'un objet de lecteur. Les personnalisations peuvent inclure des paramètres, des styles et des plugins. Pour une liste complète des possibilités de personnalisation, reportez-vous au Guide de configuration du lecteur.

    Joueurs enfants - Les joueurs enfants, créés à l'aide des API Incorporer, résultent de la création de plusieurs instances d'un joueur. Le joueur possède la majeure partie des propriétés que vous souhaitez que votre joueur ait, puis vous pouvez utiliser un joueur enfant pour personnaliser des sous-ensembles de propriétés sur différentes instances de joueur. Un joueur enfant ne peut définir que des supports à ajouter à un lecteur donné, ou il peut définir des paramètres ou des remplacements de style qui modifient le lecteur commun auquel il appartient. Les modifications apportées aux paramètres du joueur parent s'appliqueront à tous les joueurs enfants engendrés par le joueur parent. Consultez le Guide d'intégration des API pour plus de détails.

    Ce diagramme montre les relations entre le modèle par défaut, les joueurs et les joueurs enfants.

    Hiérarchie des entités du joueur
    Hiérarchie des entités du joueur

    Lorsque vous utilisez l'API de gestion du lecteur pour la première fois, un lecteur par défaut Brightcove est généré dans votre compte. Cet objet joueur est pour vous de le faire comme vous le souhaitez. Vous pouvez l'utiliser tel tel qu'il est, modifier ses paramètres, le remodeler ou ajouter des plugins. Vous pouvez choisir d'utiliser uniquement le lecteur par défaut de Brightcove avec vos personnalisations, ou vous pouvez choisir de créer d'autres joueurs pour capturer différents looks et paramètres pour différents emplacements sur votre site Web.

    Présentation de la publication

    L'une des caractéristiques du système de gestion du joueur est la possibilité de séparer les modifications que vous souhaitez tester de la version de votre lecteur qui est publiée publiquement. Dans l'interface utilisateur et dans l'API, lorsque vous apportez des modifications à la configuration d'un joueur, les modifications sont immédiatement disponibles via les versions d'aperçu du lecteur. Ces versions de prévisualisation sont entièrement utilisables et testables. Vous pouvez partager l'URL d'aperçu pour approbation ou travailler sur l'aperçu du lecteur jusqu'à ce que les modifications soient satisfaites, le tout avant de publier le lecteur pour le rendre public.

    Mise à jour des chutes

    La publication d'un lecteur a des conséquences qui peuvent affecter les joueurs enfants. Voici des détails sur la publication :

    • Une publication de lecteur déclenche une nouvelle publication de toutes les instances de joueur enfant créées à partir de ce lecteur.
    • Une publication d'un joueur enfant affecte uniquement ce joueur enfant.
    • Une mise à jour du modèle par défaut de Brightcove (contrôlée par Brightcove) déclenche une republication de tous les joueurs, et le joueur republiera à son tour une nouvelle publication de tous les joueurs enfants créés à partir de chaque joueur.

    Les paramètres sont appliqués de manière enfant gagne. Cela signifie que les paramètres au niveau enfant prévaudront sur les modifications apportées au niveau parent. Considérez ce qui suit :

    • Le modèle par défaut définit une valeur CSS pour être rouge.
    • Un lecteur définit la même valeur CSS pour être blanche.
    • Un joueur enfant définit la même valeur CSS pour être bleu.

    Puisque l'enfant gagne, les résultats seraient :

    • La valeur CSS du joueur est blanche.
    • La valeur CSS du joueur enfant est bleue.

    Ce comportement d'héritage peut être modifié si le type de données de la propriété est un tableau. La section Champs de la baie du Guide d'intégration des API décrit les détails.

    Options de configuration

    Afin de créer un joueur plus avancé que le joueur par défaut, vous devez fournir une configuration de joueur. La configuration est définie à l'aide de JSON.

    Limitation du taux

    L'API de gestion du lecteur a une limite de débit pour chaque adresse IP unique activée. Voici les limites tarifaires :

    Type de demande Limite
    Publier et créer (joueurs et incorporés) 60 requêtes/minute
    Lire (GET) 600 demandes/minute
    Ecrire (POST, PUT, PATCH et DELETE) 300 demande/minute
    Prévisualisation du lecteur 100 demandes/minute

    Codes d'état de réponse

    Les codes/messages de réponse et d'erreur sont basés sur ceux définis par W3. Certains des codes les plus fréquemment vus sont :

    • 200 Demande de succès
    • 201 Créé (un joueur, une configuration)
    • 400 Bad request - la syntaxe de l'appel API est probablement incorrecte
    • 401 Authentification non valide - vérifiez si le mot de passe a été entré correctement ou si vous avez correctement suivi les instructions OAuth
    • 404 Introuvable - vérifiez si la ressource existe et si l'URL utilisée dans l'appel d'API est correcte
    • 429Limite de débit dépassée
    • Erreur de serveur interne500 - une erreur s'est produite lors de la tentative de répondre à la demande