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

    Présentation : API des profils d'intégration

    Dans cette rubrique, vous obtiendrez une vue d'ensemble de l'API Ingest Profiles. L'API Ingest Profiles vous permet de créer, récupérer, mettre à jour et supprimer des profils associés pour votre compte Video Cloud.

    Gestion des profils d'intégration

    Notez que cette version de la vue d'ensemble concerne les comptes qui sont activés pour la remise dynamique. Ces comptes peuvent être activés ou non pour l' encodage contextuel. Il existe une vue d'ensemble séparée pour les profils d'ingest hérités.

    Les profils d'ingest sont utilisés comme spécification pour le transcodage lorsque vous téléchargez ou retranscodez des vidéos. Vous pouvez gérer ces profils à l'aide de l'API Ingest Profiles.

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

    Glossaire des termes

    Profil JSON

    Le terme « profil JSON » ci-dessous signifie la représentation JSON d'un objet de profil. Ils contiennent des champs de profil de niveau supérieur et une collection d'objets associés sous forme de liste. Voir Profils standard pour voir le JSON pour les profils standard inclus dans chaque compte et Content Security (DRM et HLSE) pour les exemples de profils qui incluent l'emballage DRM.

    ID de profil

    UNE profile id peut être soit le id ou name champ de niveau supérieur dans un profil. Dans cet exemple (fragment d'un profil) :

    {
		"id": "f1b16093e2dc4f81810f1488",
		"version": 1,
		"name": "multi-platform-extended-static",
		"description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.", ...

    « multi-platform-extended-static » ou « f1b16093e2dc4f81810f1488" sont les deux identifiants de profil valides. Lorsque vous créez un profil pour la première fois, vous fournissez un profil avec un nom mais sans identifiant, et la réponse contiendra le profil créé, y compris son identifiant. Vous pouvez ensuite utiliser l'une ou l'autre sur n'importe quel appel d'API ultérieur.

    ID de référence

    A reference_id identifie de manière unique un format associé dans un profil. Les identifiants de référence sont utilisés pour l'emballage DRM et peuvent être utilisés à d'autres fins à l'avenir. En plus d'être uniques dans le profil, les identifiants de référence peuvent être n'importe quelle chaîne - il ne doit pas inclure d'espaces. Nous recommandons d'utiliser un schéma qui facilitera l'identification du format associé, par exemple : mp4_1, mp4_2, hls1, hls2, etc.

    Version du profil

    A version est le numéro de révision d'un profil pour un compte. Il est représenté par une valeur entière longue. Note : il n'est pas cité dans la représentation JSON.

    Profil actif

    Un profil est active s'il peut être utilisé pour les téléchargements. Par exemple, si vous mettez à jour un profil, vous obtenez un nouveau profil avec un numéro de version incrémenté qui est actif et l'ancienne version devient inactive.

    Profil standard

    Un profil est standard s'il est fourni pour être utilisé par Brightcove (c'est-à-dire qu'il ne s'agit pas d'un profil personnalisé spécifique à un seul compte).

    Profil par défaut

    Un profil est default s'il est utilisé lorsqu'aucun profil n'est explicitement choisi. Si vous n'avez pas de configuration de compte ou si vous ne définissez pas de profil par défaut dans votre configuration, l'un des standard profils Brightcove sera utilisé en fonction de votre type de compte.

    URL de base

    L'URL du service est :

    https://ingestion.api.brightcove.com/v1/

    Autorisation

    L'autorisation de l'API se fait via l'implémentation OAuth2 de Brightcove. Vous aurez besoin des informations d'identification client (un identifiant client et un secret client) qui disposent des autorisations pour les opérations suivantes sur votre (vos) compte (s) :

    • video-cloud/ingest-profiles/profile/read
    • video-cloud/ingest-profiles/profile/write
    • video-cloud/ingest-profiles/account/read
    • video-cloud/ingest-profiles/account/write

    Pour obtenir un client_id et client_secret , vous devez accéder à l'interface utilisateur OAuth et enregistrer une application :

    Vous pouvez également obtenir vos informations d'identification via CURL ou Postman - voir :

    Vous utiliserez vos informations d'identification client pour obtenir des jetons d'accès qui vous permettront d'effectuer des appels à l'API. Les jetons d'accès sont transmis dans un en-tête Autorisation :

    Authorization: Bearer {your_access_token}

    Consultez la section Oauth pour plus d'informations.

    Nombre maximal de formats associés

    Voir Meilleures pratiques d'ingest Profils.

    Opérations de compte

    Au niveau du compte, vous pouvez obtenir tous les profils pour le compte et en créer de nouveaux.

    Point de terminaison

    /accounts/{account_id}/profiles

    Obtenir tous les profils

    Pour obtenir tous les profils du compte (y compris les profils standard), vous envoyez une requête GET au point de terminaison indiqué ci-dessus.

    Créer un profil

    Pour créer un nouveau profil, vous soumettez une demande POST au point de terminaison indiqué ci-dessus, y compris les données JSON pour le profil en tant que corps de la demande. Reportez-vous à la référence de l'API pour plus de détails et d'exemples de corps de demande, et à la référence des champs de profil pour les champs autorisés.

     

    Créer un profil en direct

    Pour créer un profil d'ingeste personnalisé pour Live, il vous suffit de spécifier des formats associés HLS avec la live_stream valeur true:

    {
  "media_type": "video",
  "format": "ts",
  "segment_seconds": 6,
  "label": "hls1080p",
  "live_stream": true,
  "video_codec": "h264",
  "video_bitrate": 4000,
  "keyframe_interval": 60,
  "width": 1920,
  "height": 1080,
  "h264_profile": "high"
}

    Notez que vous devez utiliser uniquement les rendition paramètres d'ingeste hérités pour les profils en direct, et non les dynamic_origin paramètres des profils de remise dynamique.

    Opérations de profil unique

    Pour les profils individuels, vous pouvez obtenir le profil par nom ou ID, remplacer un profil et supprimer un profil.

    Point de terminaison

    /accounts/{account_id}/profiles/{profile_id}

    Pour le profile_id, vous pouvez utiliser soit le :

    • nom (par exemple multi-plates-forme-standard-statique)
    • identifiant généré (par exemple f1b16093e2dc4f81810f1488)

    Obtenir un profil par id

    Pour récupérer un seul profil, faites une requête GET au point de terminaison indiqué ci-dessus.

    Mettre à jour un profil

    Pour mettre à jour un profil, effectuez une requête PUT au point de terminaison ci-dessus, y compris les données JSON complètes pour le profil dans le corps de la requête.

    Supprimer un profil

    Pour supprimer un profil, effectuez une requête DELETE au point de terminaison ci-dessus.

    Cette action est irréversible

    Opérations de profil par défaut

    Vous pouvez obtenir, définir ou mettre à jour les profils vidéo à la demande et vidéo en direct par défaut pour votre compte à l'aide du point de terminaison :

    /accounts/{account_id}/configuration

    Obtenir le profil par défaut

    Récupérez le profil par défaut de votre compte en effectuant une requête GET au point de terminaison ci-dessus.

    Si aucun profil par défaut n'a été défini, le profil par défaut du système sera renvoyé.

    Définir le profil par défaut

    Pour définir le profil par défaut, effectuez une requête POST au point de terminaison indiqué ci-dessus, y compris le JSON dans le corps de la requête :

    {
  "account_id": {account_id},
  "default_profile_id": {default_profile_id}
}

    Pour le default_profile_id, vous pouvez utiliser l'un des éléments suivants :

    • nom (par exemple multi-plates-forme-standard-statique)
    • identifiant généré (par exemple f1b16093e2dc4f81810f1488)

    Mettre à jour le profil par défaut

    Pour mettre à jour le profil par défaut, effectuez une requête PUT au point de terminaison indiqué ci-dessus, y compris ce JSON dans le corps de la requête :

    {
  "id": {configuration_id},
  "account_id": {account_id},
  "default_profile_id": {default_profile_id}
}

    Obtenez le configuration_id de la réponse à une requête GET ou POST.

    Définition du profil dynamique par défaut

    La définition du profil en direct par défaut est exactement la même que celle du profil vidéo à la demande par défaut, à l'exception de cette modification dans le corps de la requête :

    {
  "id": {configuration_id},
  "account_id": {account_id},
  "default_live_profile_id": {default_live_profile_id}
}

    Définition du profil d'écrêtage social par défaut

    La définition du profil d'écrêtage social par défaut est exactement la même que la définition du profil vidéo à la demande par défaut, à l'exception de cette modification dans le corps de la requête :

    {
  "id": {configuration_id},
  "account_id": {account_id},
  "default_social_clipping_profile_id": {default_social_clipping_profile_id}
}

    Remarques :

    • Si vous spécifiez un profil inexistant, la demande échouera

    Exemple de profil

    Le document Profils standard affiche tous les profils par défaut qui existent actuellement pour tous les comptes Video Cloud.

    Filigranes

    Si vous souhaitez ajouter des filigranes (ou une image de logo) à vos vidéos, contactez le support Brightcove.