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

Intégration de votre CMS avec Video Cloud

Dans cette rubrique, vous apprendrez les opérations de base impliquées dans l'intégration de Brightcove Video Cloud avec un CMS. Il répertorie les fonctions typiques que les utilisateurs exécutent dans le CMS et les opérations de l'API Brightcove qui peuvent être utilisées pour fournir cette fonctionnalité.

Fonctions utilisateur

Voici les fonctions liées à Video Cloud que vous pourriez vouloir fournir aux utilisateurs de votre CMS:

  • Ajouter de nouvelles vidéos à Video Cloud
  • Remplacer un Video Cloud vidéo avec une nouvelle version
  • Mettre à jour les métadonnées pour les vidéos, telles que le titre, la description et les tags
  • Supprimer des vidéos
  • Créer des playlists
  • Changer les vidéos dans une playlist
  • Supprimer les playlists
  • Créer une vidéo players
  • Modifier la vidéo player propriétés, telles que les dimensions ou le style
  • Ajouter des fonctionnalités spéciales à la vidéo players via des plugins
  • Publier des vidéos ou des playlists uniques
  • Fournir des données analytiques sur les charges vidéo, les vues, les taux de lecture, l'engagement, etc.

Vous ne souhaiterez peut-être pas exposer toutes ces fonctionnalités à vos utilisateurs finaux - vous ne voudrez peut-être pas les laisser supprimer des vidéos, par exemple. Un des avantages de l'intégration Video Cloud avec votre CMS plutôt que de laisser les utilisateurs aller directement à Video Cloud Studio est que vous pouvez choisir exactement les fonctionnalités à exposer aux utilisateurs via les API Brightcove.

Authentification

Pour toutes les demandes d'API Brightcove, l'authentification est basée sur les jetons d'accès OAuth2. Il existe un processus en deux étapes pour obtenir des jetons d'accès:

  1. Créer des informations d'identification client avec des autorisations pour les opérations d'API dont vous avez besoin
  2. Utilisez les informations d'identification du client pour créer un jeton d'accès temporaire pour authentifier une demande d'API

Création d'informations d'identification client

La création d'informations d'identification client est une opération ponctuelle qui peut être effectuée via Video Cloud Studio ou le OAuth API . Cependant vous le faites, un client_id et client_secret sont renvoyés, que vous devez enregistrer pour demander des jetons d'accès.

Créer un jeton d'accès

Les jetons d'accès temporaires sont créés à l'aide du OAuth API . le client_id et client_secret doit être encodé en BASE64 et transmis en tant que Basic Chaîne d'autorisation

Le système d'implants dentaires access_token retourné est retourné passé dans un en-tête Authorization avec l'appel de l'API:

    >Authorization: Bearer your_access_token
    
    

Les jetons d'accès sont valables pour les minutes 5. Sauf si vous effectuez une sorte d'opération par lot qui effectuera des centaines d'appels d'API successifs, il est logique de simplement en demander un nouveau pour chaque appel d'API plutôt que d'essayer de garder une trace du délai d'attente.

Ajouter des vidéos

Si vous souhaitez permettre aux utilisateurs d'ajouter des vidéos à Video Cloud de votre CMS, vous pouvez le faire en utilisant le Dynamic Ingest API . Nous vous recommandons de demander aux utilisateurs de télécharger des vidéos dans votre référentiel, qui peut être un compartiment S3 ou un serveur public. Le système Dynamic Ingest peut extraire les vidéos et les ajouter au Video Cloud système à l'aide d'un processus en deux étapes décrit ci-dessous.

Ajouter un objet vidéo à Video Cloud

La première étape consiste à créer un objet vidéo dans le Video Cloud système en faisant un POST demande à la CMS API:

    https://cms.api.brightcove.com/v1/accounts/:account_id/videos
    
    

Le corps de la requête inclura les propriétés vidéo de base dans un JSON objet - minimalement, la vidéo name, mais vous pouvez également inclure des métadonnées supplémentaires telles qu'un description et tags:

    {
    "name": "Woodpecker",
    "description": "A bird that hunts insects inside wood",
    "reference_id": "Bird_Woodpecker.mp4",
    "tags": ["bird", "air", "nature"]
    }
    
    

Ingérer la vidéo

Lorsque vous créez l'objet vidéo, le CMS API retournera un JSON objet contenant les propriétés de la vidéo. Vous allez extraire la vidéo id du JSON, et l'utiliser pour faire un appel à la Dynamic Ingest API pour demander l'intégration et le transcodage de la vidéo:

    https://ingest.api.brightcove.com/v1/accounts/ACCOUNT_ID/videos/VIDEO_ID/ingest-requests
    
    

Encore vous enverrez JSON dans le corps de la requête spécifiant l'emplacement du fichier vidéo:

    {
      "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
      },
      "profile":"multi-platform-extended-static",
      "capture-images": true
    }
    
    

Le système d'implants dentaires profile Voici le profil d'ingestion qui spécifie quels rendus doivent être créés dans le processus de transcodage. Dans la plupart des cas, l'un des profils standard suivants devrait être adéquat:

Profils de livraison dynamique

  • multi-platform-extended-static
  • multi-platform-standard-static

Les profils hérités hérités

  • videocloud-default-v1 (the default)
  • screencast-1280
  • smart-player-transition
  • single-bitrate-high
  • audio-only
  • single-bitrate-standard
  • high-resolution

Cependant, vous pouvez créer des profils d'acquisition personnalisés supplémentaires, si nécessaire, en utilisant le Ingest Profiles API Ou en utilisant Video Cloud Studio.

Ajouter une affiche et des vignettes

Le système d'implants dentaires capture-images option dans le code ci-dessus indique Video Cloud pour capturer des affiches et des images miniatures pour la vidéo à mi-chemin pendant le processus de transcodage. Alternativement, vous pouvez définir capture-images à false et d'ingérer des images à la place, soit en même temps que vous ingérer la vidéo ou plus tard:

    {
    "master":{
    "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
    },
    "profile":"multi-platform-extended-static",
    "capture-images": false,
    "poster": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
    "width": 640,
    "height": 360
    },
    "thumbnail": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
    "width": 160,
    "height": 90
    }
    }
    
    

Voir Images et Dynamic Ingest API pour plus de détails.

Ajout de pistes de texte pour les légendes ou les chapitres

Vous pouvez également utiliser la Dynamic Ingest API ajouter des pistes de texte dans WebVTT fichiers à des vidéos, soit au moment de l'ingestion ou plus tard. Les pistes de texte sont utilisées pour ajouter légendes or chapitres à une vidéo.

    {
    "master":{
    "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
    },
    "profile":"multi-platform-extended-static",
    "capture-images": false,
    "poster": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
    "width": 640,
    "height": 360
    },
    "thumbnail": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
    "width": 160,
    "height": 90
    },
    "text_tracks": [
    {
    "url": "http://learning-services-media.brightcove.com/captions/for_video/Water-in-Motion.vtt",
    "srclang": "en",
    "kind": "captions",
    "label": "English",
    "default": true
    }
    ]
    }
    
    

Voir Ingérer des fichiers WebVTT pour plus de détails.

Gérer les vidéos

Le système d'implants dentaires CMS API vous permet de récupérer des données vidéo pour un compte. (Comme indiqué ci-dessus, il est également utilisé pour créer des objets vidéo dans le cadre du processus d'ingestion vidéo.) La requête la plus simple est la suivante:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos
    
    

Par défaut, cette requête renvoie un JSON tableau d'objets vidéo 20 contenant une multitude de métadonnées, y compris le nom, la description, les tags, les champs personnalisés, les dates de création et de modification, les URL pour l'affiche et la vignette, et bien plus encore.

Vous pouvez affiner les résultats de la requête en ajoutant un ou plusieurs des paramètres suivants à la requête:

limit
cela détermine le nombre d'objets vidéo à renvoyer, et peut être défini sur n'importe quel nombre 100 - la valeur par défaut est 20
offset
cela détermine le nombre d'éléments à ignorer, et est donc utilisé avec limit pour parcourir le catalogue de vidéos - la valeur par défaut est 0
sort
cela détermine le champ de métadonnées vidéo pour trier le résultat par - par défaut, les résultats sont triés par updated_at (décroissant, pour afficher les vidéos les plus récemment mises à jour en premier)

Voir CMS API Vue d'ensemble - Paramètres pour des informations détaillées sur ces paramètres.

Rechercher des vidéos

Vous pouvez également rechercher des vidéos selon un large éventail de critères en utilisant q paramètre. Vous pouvez effectuer une recherche par champs spécifiques tels que le nom, la description et les balises, ainsi que les dates et l'état des vidéos:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos?q=tags:sea,mammal
    
    

Pour plus de détails et toutes les options de recherche, voir Rechercher des vidéos.

Obtenir et mettre à jour une vidéo spécifique

Pour récupérer une vidéo spécifique par son identifiant ou son identifiant de référence:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos/id
    or
    https://cms.api.brightcove.com/v1/accounts/account_id/videos/ref:reference_id
    
    

A GET request renvoie l'objet vidéo. Pour le mettre à jour, modifiez le JSON et le retourner en utilisant un PATCH demande à la même URL.

Playlists

Les informations de la playlist sont également gérées à l'aide du CMS API de la même manière que l'information vidéo. Notez que Video Cloud prend en charge huit types de playlists dans deux catégories:

Manuel (ou EXPLICIT) playlists
contenir un ensemble spécifié de vidéos - jusqu'à des vidéos 100 peuvent être incluses
Listes de lecture intelligentes
construit dynamiquement à l'exécution en fonction de critères de recherche - il existe sept types de listes de lecture intelligentes correspondant à l'ordre dans lequel les vidéos sont classées dans la liste:
  • ACTIVATEDOLDESTTONEWEST
  • ACTIVATEDNEWESTTOOLDEST
  • ALPHABETICAL
  • PLAYSTOTAL
  • PLAYSTRAILINGWEEK
  • STARTDATEOLDESTTONEWEST
  • STARTDATENEWESTTO_OLDEST

La limite du nombre de vidéos peut être définie sur n'importe quel nombre jusqu'à 100.

Comme pour les vidéos, vous pouvez récupérer toutes les playlists en utilisant limit et offset pour parcourir les résultats si le compte contient un grand nombre de playlists:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists
    
    

Le tableau retourné des objets de playlist comprendra des métadonnées pour la playlist, y compris les type correspondant à l'un des types décrits ci-dessus. Si le type est EXPLICIT, il y aura aussi un video_ids tableau contenant les identifiants des vidéos incluses. Si le type est l'un des types de listes de lecture intelligentes, il y aura un search propriété contenant la chaîne de recherche qui récupère les vidéos, quelque chose comme ceci:

    q=tags:fish,birds
    
    

Vous pouvez également récupérer une seule playlist par son id:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
    
    

Si vous devez récupérer les objets vidéo complets d'une liste de lecture (pour afficher des informations sur les vidéos sur une page), il vous suffit d'ajouter /videos à cette URL:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
    
    

Notez que pour une liste de lecture intelligente, la demande renvoie les vidéos correspondant aux critères de recherche actuels, mais cela peut changer.

Création d' Players

Brightcove players peuvent être créés via le Player Management API . L'API vous permet de créer players, mettez à jour leurs propriétés et obtenez le code d'intégration sous la forme d'une URL, d'un iframe tag, ou un bloc de HTML à intégrer dans la page.

Vous pouvez jusqu'à 200 playerpar compte, mais il est généralement moins déroutant pour les utilisateurs d’avoir players comme vous en avez absolument besoin. Vous devriez avoir séparé players pour lire des vidéos ou des listes de lecture uniques, mais sinon vous n'avez besoin que de players quand ils seront stylisés différemment ou auront des fonctionnalités différentes ajoutées via des plugins.

Créer un player, vous faites simplement un POST demande à la Player Management API:

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

Dans le corps de la requête, incluez le player paramétrage - La seule chose requise est un name:

    {
    "name": "Single video player for blog posts"
    }
    
    

La réponse vous donnera la player id, ainsi que le code d'intégration sous plusieurs formes:

    {
    "embed_code": "<iframe src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
    "embed_in_page": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/in_page.embed",
    "id": "de055fa4-4f09-45af-8531-419c6794ad04",
    "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
    "preview_url": "http://preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html",
    "url": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html"
    }
    
    

Pour obtenir le plein player configuration, vous faites une demande au /players point de terminaison, mais ajoutez le player ID renvoyé dans la réponse ci-dessus:

    https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04
    
    

Vous pouvez faire un PATCH demande au même point de terminaison de mettre à jour player configuration.

Vous remarquerez dans la réponse ci-dessus, le preview_embed_code et preview_url. Pour permettre le test de nouveaux players ou player mises à jour, nouvellement créées ou mises à jour playerLes paramètres sont définis en mode d'aperçu pour vous permettre de les voir avant de pousser les modifications vers celles existantes. players. Pour pousser les changements dans la production, vous devez publier le player avec cette demande:

    https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04/publish
    
    

Personnalisation Players

Le système d'implants dentaires Brightcove player est construit avec des technologies web standards: HTML, CSS, et JavaScript. Vous pouvez personnaliser le player en utilisant ces mêmes technologies. Cela peut être fait dans la page où le player est publié, mais la meilleure pratique consiste à ajouter vos personnalisations au player lui-même à travers le player paramétrage, mise à jour du player la vie PATCH demande à la Player Management API comme expliqué dans la section précédente.

Vous pouvez également ajouter des fonctionnalités et des fonctionnalités supplémentaires au player par JavaScript plugins, et il y a un vaste Player API pour vous aider à intégrer votre code avec le player. Brightcove propose un certain nombre de plugins prêts à l'emploi pour des activités telles que l'activation de la publicité, la personnalisation de l'écran final et l'ajout de superpositions.

Publier des vidéos

Dans le Création d' Playersection s ci-dessus, nous avons vu que lorsque vous obtenez le player objet de configuration à l'aide du Player Management API, les données renvoyées incluent une balise iframe pour incorporer le player dans une page HTML, et également une URL pour le code HTML complet si vous souhaitez intégrer le player directement dans une page.

Pour l'intégration que vous choisissez, vous devrez ajouter un Video Cloud identifiant vidéo ou identifiant de playlist au code intégré pour ajouter du contenu à la player. Le code intégré iframe ressemble à ceci:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html'
    allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
    
    

Vers l'URL du player, vous devez ajouter le paramètre videoId={}video_id, de sorte que le code d'intégration complet ressemblera à ceci:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
    allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
    
    

S'il s'agit d'une playlist player, vous utilisez le paramètre playlistId={playlist_id} au lieu. La modification du code d'intégration sur la page est similaire.

Sauf si player les dimensions sont fixées dans le player configuration, vous devrez également dimensionner le player en ajoutant de la largeur et de la hauteur dans un style attribut:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
    allowfullscreen webkitallowfullscreen mozallowfullscreen
    style=width:640px;height:360px;></iframe>
    
    

Obtenir des rapports d'analyse

Le système d'implants dentaires Analytics API vous permet de générer des rapports d'analyse par différents dimensions. Voir l' Guides de dimensions pour plus d’informations.

Vous pouvez spécifier la plage de dates pour le rapport, les métriques à renvoyer et vous pouvez obtenir les données dans JSON, csvou xlxs format

Pour les périodes au cours du dernier mois, vous pouvez également générer des détails EngageRapports de gestion qui montrent des vues pour chaque centième partie de la vidéo.

Résumé des API

Voici un résumé des API utiles pour l'intégration avec Video Cloud.

OAuth API
Permet de créer des informations d'identification client et des jetons d'accès pour accéder aux autres API.
Gestion des médias
Ingest Profiles API
Permet de créer des profils d'acquisition personnalisés en spécifiant les rendus à créer pour les vidéos ajoutées à Video Cloud
Dynamic Ingest API
Permet d'ajouter des vidéos et des éléments multimédias associés à Video Cloud
CMS API
Permet de créer des objets vidéo à des fins d'intégration et de gérer des vidéos et des playlists
Brightcove Players
Le système d'implants dentaires Brightcove Player
Le système d'implants dentaires player comprend un JavaScript API pour interagir avec le player lors de l'exécution
Player Management API
Utilisé pour créer et configurer players, et pour obtenir le player code intégré
Analytics API
Utilisé pour obtenir des rapports d'analyse sur les performances vidéo

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