Introduction
L'API Ingest Profiles vous permet de :
-
Obtenir les profils de votre compte
-
Créer de nouveaux profils
-
Actualiser les profils
-
Supprimer les profils
-
Définir ou mettre à jour le profil par défaut de votre compte
Une API RESTFUL
L'API Ingest Profiles est une API RESTful. Il accepte les requêtes HTTPS et renvoie une réponse JSON.
Cela signifie que vous pouvez utiliser l'API avec n'importe quel langage que vous choisissez - Ruby, Java, PHP, Python, JavaScript (via AJAX ou nodejs), etc. Tout ce que vous devez être en mesure de faire est de faire des requêtes HTTPS et de gérer une réponse JSON.
L'URL de base
L'URL de base de l'API Ingest Profiles est :
https://ingestion.api.brightcove.com/v1
Autorisation
Les appels d'API sont autorisés à l'aide des jetons d'accès OAuth2. Le jeton est passé avec les requêtes dans un en-tête d'autorisation :
Authorization: Bearer {access_token}
Les jetons d'accès sont de courte durée (5 min), vous devez donc en obtenir un chaque fois que vous faites une demande
Dans ces exercices, nous ferons des requêtes via un proxy qui va récupérer un jeton d'accès, puis faire la requête.
Configuration des exercices
Configuration
Vous avez deux options :
- Effectuer les exercices sur un compte d'échantillon (recommandé)
- Utilisez votre propre compte
Obtenir tous les profils
Obtention des profils de compte
Pour obtenir tous les profils d'un compte, effectuez une requête GET au point de terminaison :
/accounts/{account_id}/profiles
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
Exercice 1 : Obtenir tous les profils
Effectuez la requête GET suivante :
Création d'un profil
Création de profils
Pour créer un profil, effectuez une requête POST au point de terminaison :
/accounts/{account_id}/profiles
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
Le JSON du profil est inclus en tant que corps de requête. Voir la référence de champ de profil pour les champs de profil, format associé et package DRM.
Exercice 2 : Créer un profil
Effectuez la demande POST suivante :
Exercice 2 Réponse
Obtenir un seul profil
Obtention d'un profil par id
Pour récupérer un profil par id, effectuez une requête GET au point de terminaison :
/accounts/{account_id}/profiles/{profile_id}
Pour le profile_id
, vous pouvez utiliser soit le :
- nom (par exemple équilibré haute définition)
- identifiant généré (par exemple 54de14cce4b0a6d2bf9cb08a)
Exemples :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/screencast
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/54de14cce4b0a6d2bf9cb08a
Exercice 3 : Obtenir un profil
Effectuez la requête GET suivante pour récupérer le profil que vous avez créé :
Mise à jour d'un profil
Mettre à jour un profil par id
Pour mettre à jour un profil par id, effectuez une requête PUT au point de terminaison :
/accounts/{account_id}/profiles/{profile_id}
Pour le profile_id
, vous pouvez utiliser soit le :
- nom (par exemple équilibré haute définition)
- identifiant généré (par exemple 54de14cce4b0a6d2bf9cb08a)
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
Incluez les données de profil dans le corps de la requête comme vous l'avez fait lors de la création du profil. Les données du profil doivent inclure le id
pour le profil !
Exercice 4 : Mises à jour
Faites la requête PUT suivante pour mettre à jour le profil que vous avez créé (la description sera mise à jour) :
Exercice 4 Réponse
Suppression d'un profil
Supprimer un profil par id
Pour supprimer un profil par id, effectuez une requête DELETE au point de terminaison :
/accounts/{account_id}/profiles/{profile_id}
Pour le profile_id
, vous pouvez utiliser soit le :
- nom (par exemple équilibré haute définition)
- identifiant généré (par exemple 54de14cce4b0a6d2bf9cb08a)
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
Exercice 5 : Supprimer le profil
Effectuez la demande DELETE suivante pour mettre à jour le profil que vous avez créé (ne peut pas être annulé !) :
Obtention du profil par défaut
Obtenir le profil par défaut
Pour obtenir le profil par défaut du compte, effectuez une requête GET au point de terminaison :
/accounts/account_id/configuration
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Exercice 6 : Obtenir le profil par défaut
Effectuez la requête GET suivante pour obtenir le profil par défaut du compte :
Définition du profil par défaut
Définir le profil par défaut
Pour définir le profil par défaut du compte, effectuez une requête POST au point de terminaison :
/accounts/account_id/configuration
Inclure ce JSON en tant que corps de requête
{
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
Comme avec d'autres opérations, vous pouvez utiliser le nom ou l'id pour le profile_id
.
- nom (par exemple équilibré haute définition)
- identifiant généré (par exemple 54de14cce4b0a6d2bf9cb08a)
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Exercice 7 : Définir le profil par défaut
Faites la requête POST suivante pour définir le profil par défaut (notez que cela échouera si le compte a déjà un profil par défaut - nous mettrons à jour la valeur par défaut dans l'exercice suivant) :
Exercice 7 Réponse
Mise à jour du profil par
Mettre à jour le profil par défaut
Pour mettre à jour le profil par défaut du compte, effectuez une requête PUT au point de terminaison :
/accounts/account_id/configuration
Inclure ce JSON en tant que corps de requête
{
"id": {configuration_id},
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
L'ID de configuration est renvoyé lorsque vous obtenez le profil par défaut. S'il n'y a pas de profil par défaut, reportez-vous à la section Définition du profil par défaut. Comme avec d'autres opérations, vous pouvez utiliser le nom ou l'id pour le profile_id
.
- nom (par exemple haute résolution)
- identifiant généré (par exemple 54de14cce4b0a6d2bf9cb08a)
Exemple :
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Exercice 8 : Mettre à jour le profil par
Effectuez la demande PUT suivante pour mettre à jour le profil par défaut du compte :