Vue d'ensemble : Ingérer l'API des profils

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 de rendu pour votre compte Video Cloud.

Gestion des profils d'ingest

Notez que les comptes Brightcove peuvent être activés ou non pour Encodage contextuel.

Les profils d'ingestion 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 aussi le Référence API.

Glossaire des termes

Profil JSON

Le terme "profil JSON" ci-dessous désigne la représentation JSON d'un objet de profil. Ils contiennent des champs de profil de niveau supérieur et une collection d'objets de rendu sous forme de liste.

Carte d'indentité

UNE profile id peut être soit le id ou name champ de niveau supérieur dans un profil. Dans cet exemple (un fragment de 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 tous deux des 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'un ou l'autre lors de tout appel d'API ultérieur.

Pièce d'identité

UNE reference_id identifie de manière unique un rendu dans un profil. Les identifiants de référence sont utilisés pour l'empaquetage DRM et peuvent être utilisés à d'autres fins à l'avenir. En plus d'être uniques au sein du profil, les identifiants de référence peuvent être n'importe quelle chaîne ; ils ne doivent pas inclure d'espaces. Nous vous recommandons d'utiliser un schéma qui permettra d'identifier facilement le format du rendu, par exemple : mp4_1 mp4_2 hls1, hls2, , etc.

Version du profil

UNE version est le numéro de révision d'un profil pour un compte. Il est représenté par une valeur entière longue. Remarque : 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 les profils seront utilisés conformément à votre type de compte.

URL de base

L'URL du service est :

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

Autorisation

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

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 :

Gestion des informations d'identification d'authentification API

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 de passer des appels à l'API. Les jetons d'accès sont transmis dans un en-tête d'autorisation :

Authorization: Bearer {your_access_token}

Voir le Section Oauth pour plus d'informations.

Rendus maximaux

Voir Meilleures pratiques pour les profils d'ingestion.

Opérations de compte

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

Point de terminaison

/accounts/{account_id}/profiles

Obtenez tous les profils

Pour obtenir tous les profils du compte (y compris profils standards), vous soumettez une demande 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, en incluant les données JSON pour le profil en tant que corps de la demande. Voir le Référence API pour plus de détails et des exemples de corps de demande, et le Référence des champs de profil pour les champs autorisés.

Créer un profil en direct

Pour créer un profil d'ingestion personnalisé pour Live, il vous suffit de spécifier les rendus HLS avec la live_stream valeur suivante 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 ne devez utiliser que l'acquisition héritée rendition paramètres pour les profils en direct, ne pas les dynamic_origin paramètres pour les profils de livraison dynamique.

Opérations à profil unique

Pour les profils individuels, vous pouvez obtenir le profil par nom ou identifiant, 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-plateforme-standard-statique)
identifiant généré (par exemple f1b16093e2dc4f81810f1488)

Obtenir un profil par identifiant

Pour récupérer un seul profil, envoyez 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.

Remarque : le JSON du profil mis à jour doit inclure le id biens.

Supprimer un profil

Pour supprimer un profil, faites une demande 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 de vidéo à la demande et de 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 demande 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, envoyez une requête POST au point de terminaison indiqué ci-dessus, en incluant 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'une des méthodes suivantes :

nom (par exemple multi-plateforme-standard-statique)
identifiant généré (par exemple f1b16093e2dc4f81810f1488)

Mettre à jour le profil par défaut

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

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

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

Définir le profil en direct par défaut

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

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

Définition du profil de coupure sociale par défaut

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

{
  "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

Les Profils standards document vous montrera 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, Contacter l'assistance Brightcove.