Paper Contacter le support | état du système L'état du système

Aperçu: Player Management API

Player La gestion désigne la création, l'édition et la gestion de players comme ressource pour les éditeurs. Player La gestion est assurée par une API REST côté serveur qui permet à ses consommateurs de créer, configurer, prévisualiser et publier player les instances.

Introduction

Création et mise à jour players se fait selon une approche en deux phases. Plutôt que d'appliquer automatiquement toutes les modifications à la production players, les modifications sont séparées en aperçu et publiées. Vous pouvez maintenant effectuer toutes les mises à jour que vous souhaitez sur votre aperçu player sans affecter ce que voient vos utilisateurs finaux. Vous pouvez choisir de publier les modifications à tout moment.

Le système d'implants dentaires Player Management API permet à un utilisateur de:

  1. Créer un player
  2. Afficher les paramètres d'un player
  3. Modifier les paramètres d'un player
  4. Liste tous les players associé à l'éditeur
  5. Publier un player le mettre à la disposition du consommateur

Voir aussi le Référence de l'API.

URL de base

L'URL de base de l'API est la suivante:

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

Introduction

Le système d'implants dentaires player système de gestion est composé de trois objets clés. Ils sont le modèle par défaut, players et enfant players.

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 players créé. Ces fichiers sont finalement compilés avec player paramètres et entraîner le code réel qui est chargé dans le navigateur (le player). Il n'y a actuellement qu'un seul modèle utilisé à l'échelle du système. En tant que tel, il n'y a pas de visibilité sur le modèle via l'API.

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

Enfant Players - Enfant players, créés à l'aide des API Embed, sont le résultat de la création de plusieurs instances d'un player. le player a la majeure partie des propriétés que vous souhaitez player avoir, puis vous pouvez utiliser un enfant player pour personnaliser des sous-ensembles de propriétés sur différents player instances. Un enfant player peut uniquement définir des médias à ajouter à un player, ou il pourrait définir tout paramètre ou remplacement de style qui modifie le player auquel il appartient. Changements au parent player les paramètres s'appliqueront à tous les enfants players engendré par le parent player. . Check out the Consultez le Embed APIs Guide pour plus de détails.

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

Player Hiérarchie des entités
Player Hiérarchie des entités

Lorsque vous utilisez le Player Management API pour la première fois, un Brightcove par défaut Player est généré dans votre compte. Cette player l'objet est pour vous de faire comme vous le souhaitez. Vous pouvez l'utiliser tel quel, modifier ses paramètres, le redéfinir ou ajouter des plugins. Vous pouvez choisir d'utiliser uniquement le Brightcove par défaut Player avec vos personnalisations, ou vous pouvez choisir de créer d'autres players pour capturer différents looks et paramètres pour différents emplacements sur votre site Web.

Présentation de la publication

Une des caractéristiques de la Player Le système de gestion est la possibilité de séparer les modifications que vous souhaitez tester de la version de votre player qui est publiquement publié. Dans l'interface utilisateur et l'API, lorsque vous apportez des modifications à un playerconfiguration, les modifications sont immédiatement disponibles via les versions d’aperçu du player. Ces versions d'aperçu sont entièrement utilisables et testables. Vous pouvez partager l'URL d'aperçu pour approbation ou travailler sur le player aperçu jusqu'à ce que vous soyez satisfait des modifications, le tout avant de publier le player pour le rendre public.

Mettre à jour les cascades

Publier un player a des conséquences qui peuvent affecter l'enfant players. Voici les détails de la publication:

  • A player publier déclenche une nouvelle publication de tous les enfants player les instances créées à partir de cette player.
  • Un enfant player publier affecte uniquement cet enfant player.
  • Une mise à jour du modèle par défaut de Brightcove (contrôlée par Brightcove) déclenchera une nouvelle publication de tous players, et le player une nouvelle publication déclenchera à son tour une nouvelle publication de tous les enfants players créés à partir de chacun player.

Les paramètres sont appliqués de la manière d'un enfant gagne. Cela signifie que les paramètres au niveau de l'enfant auront la priorité sur les modifications apportées au niveau parent. Considérer ce qui suit:

  • Le modèle par défaut définit une valeur CSS à être rouge.
  • A player définit la même valeur CSS comme étant blanche.
  • Un enfant player définit la même valeur CSS comme étant bleue.

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

  • Le système d'implants dentaires playerLa valeur CSS de est blanc.
  • L'enfant playerLa valeur CSS de est bleu.

Ce comportement d'héritage peut être modifié si le type de données de la propriété est un tableau. le Champs de tableau section du Guide Embed APIs décrit les détails.

Options de configuration

Afin de créer un player plus avancé que la valeur par défaut player, Vous devez fournir un Player configuration. La configuration est définie à l'aide de JSON.

Limitation de débit

Le système d'implants dentaires Player Management API a la limitation de débit pour chaque adresse IP unique activée. Voici les limites de taux:

type de demande limite
Publier et créer (players et incorpore) Demandes 60 / minute
Lire (GET) Demandes 600 / minute
Write (POST, PUT, PATCH et DELETE) Demandes 300 / minute
Player Aperçu Demandes 100 / minute

Codes d'état de réponse

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

  • 200 Demande de succès
  • 201 A créé un player, une configuration)
  • 400 Mauvaise requête - la syntaxe de l'appel de l'API est probablement incorrecte
  • 401 Authentification invalide - vérifiez si le mot de passe a été entré correctement ou si vous avez suivi le Instructions OAuth correctement
  • 404 Non trouvé - vérifiez si la ressource existe et si l'URL utilisée dans l'appel de l'API est correcte
  • 429Limite de débit dépassée
  • 500 Erreur interne du serveur - une erreur s'est produite lors de la tentative d'exécution de la requête

Dernière mise à jour de la page le 12 juin 2020