Démarrage rapide: Ingest Profiles API

Introduction

Le système Ingest Profiles API vous permet de:

• Obtenez les profils pour votre compte

• Créer de nouveaux profils

• Mettre à jour

• Supprimer les profils

• Définir ou mettre à jour le profil par défaut de votre compte

Une API reposante

Le système Ingest Profiles API 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 quelle langue - Ruby, Java, PHP, Python, JavaScript (via AJAX ou nodejs), etc. Tout ce que vous devez faire est de faire des requêtes HTTPS et gérer une réponse JSON.

L'URL de base

L'URL de base pour le Ingest Profiles API est:

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

Autorisation

Les appels API sont autorisés à l'aide des jetons d'accès OAuth2. Le jeton est passé avec des demandes 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 demandes via un procuration cela va chercher un jeton d'accès et ensuite faire la demande.

Configuration pour les exercices

Obtenir tous les profils

Obtenir les profils de compte

Pour obtenir tous les profils d'un compte, envoyez une requête GET au noeud final:

    /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:

Envoyer la demande

Créer un profil

Créer des profils

Pour créer un profil, envoyez 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 la demande. Voir le Référence du champ de profil pour les champs de profil, de rendu et de package DRM

Exercice 2: Créer un profil

Effectuez la requête POST suivante:

Envoyer la demande

(La réponse apparaîtra sur la diapositive suivante)

Exercise 2 Response

Obtenir un seul profil

Obtenir un profil par identifiant

Pour récupérer un profil par id, faites une requête GET au point de terminaison:

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

Pour le profile_id, vous pouvez utiliser soit:

• nom (par exemple, équilibré-haute définition)
• generated id (e.g. 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éé:

Envoyer la demande

Mise à jour d'un profil

Mettre à jour un profil par identifiant

Pour mettre à jour un profil par ID, faites une demande PUT au point de terminaison:

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

Pour le profile_id, vous pouvez utiliser soit:

• nom (par exemple, équilibré-haute définition)
• generated id (e.g. 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 demande comme vous l'avez fait lorsque vous avez créé le profil. Les données de profil doivent inclure id pour le profil!

Exercice 4: Mettre à jour le profil

Effectuez la demande PUT suivante pour mettre à jour le profil que vous avez créé (la description sera mise à jour):

Envoyer la demande

(La réponse apparaîtra sur la diapositive suivante)

Exercise 4 Response

Supprimer un profil

Supprimer un profil par identifiant

Pour supprimer un profil par ID, effectuez une requête DELETE sur le noeud final:

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

Pour le profile_id, vous pouvez utiliser soit:

• nom (par exemple, équilibré-haute définition)
• generated id (e.g. 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é!):

Envoyer la demande

Obtenir le profil par défaut

Obtenir le profil par défaut

Pour obtenir le profil par défaut du compte, envoyez une requête GET au noeud final:

    /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:

Envoyer la demande

Définition du profil par défaut

Définir le profil par défaut

Pour définir le profil par défaut du compte, envoyez une demande POST au noeud final:

    /accounts/account_id/configuration

Inclure ce fichier JSON en tant que corps de requête

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

Comme pour les autres opérations, vous pouvez utiliser le nom ou l'identifiant profile_id.

• nom (par exemple, équilibré-haute définition)
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Exemple:

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                        

Exercice 7: Définir le profil par défaut

Effectuez la demande 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):

Envoyer la demande

(La réponse apparaîtra sur la diapositive suivante)

Exercise 7 Response

Mise à jour du profil par défaut

Mettre à jour le profil par défaut

Pour mettre à jour le profil par défaut du compte, envoyez une demande PUT au système d'extrémité:

    /accounts/account_id/configuration

Inclure ce fichier 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, voir Définir le profil par défaut. Comme pour les autres opérations, vous pouvez utiliser le nom ou l'identifiant profile_id.

• nom (par exemple haute résolution)
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Exemple:

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                        

Exercice 8: Mettre à jour le profil par défaut

Effectuez la demande PUT suivante pour mettre à jour le profil par défaut du compte:

Envoyer la demande

(La réponse apparaîtra sur la diapositive suivante)

Exercise 8 Response