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

    Utiliser Postman pour les requêtes API

    Dans cette rubrique, vous apprendrez comment configurer le client HTTP Postman populaire pour effectuer des requêtes aux API RESTful de Brightcove. Certains trouvent des instructions curl et la ligne de commande, utilisés pour la plupart des exemples dans cette section de la documentation, difficiles et intimidants. Pour ces derniers, il existe de nombreux outils pour envoyer des requêtes HTTP aux services REST, qui incluent la plupart des API Brightcove. Ce document vous montrera comment utiliser un tel outil, l'application Postman.

    Installer Postman

    Sortez Postman de www.getpostman.com . Postman peut être installé en tant qu'application Chrome ou Mac. Nous vous recommandons d'obtenir le client de bureau, mais la version Chrome s'exécutera sur n'importe quelle plate-forme et est identique en fonctionnalité et en apparence.

    Obtenir les identifiants client

    Pour travailler avec les API Brightcove, vous aurez besoin des informations d'identification client pour le compte et les API que vous souhaitez utiliser. Obtenez les informations d'identification client dans Studio en suivant les instructions de la Gestion des informations d'identification d'authentification API. Dans les étapes ci-dessous, nous effectuerons des demandes d'API Player Management à l'aide Postman, de sorte que vos informations d'identification doivent avoir au moins les autorisations suivantes :

    • Joueurs: Lire écrire

    Vous pouvez ajouter autant d'autorisations supplémentaires que vous le souhaitez pour obtenir des informations d'identification qui seront utilisables pour un plus grand nombre de requêtes API. Notez également que vous obtenez des informations d'identification qui fonctionneront pour plusieurs comptes si vous le souhaitez.

    Vous pouvez utiliser cette application en ligne si vous préférez. Si vous le faites, vous devez spécifier au moins video-cloud/player/all des autorisations.

    Utilisation de Postman

    Une fois que vous avez vos informations d'identification client, vous êtes prêt à commencer à utiliser Postman. Les étapes ci-dessous vous permettront de faire certaines requêtes d' API de gestion du lecteur à l'aide de Postman.

    Configuration Postman pour obtenir des jetons d'accès

    1. Lancez l' Postman application.
    2. Créer une nouvelle demande :
      Créer une nouvelle demande
      Créer une nouvelle demande
    3. Dans la nouvelle boîte de dialogue de demande, entrez « Obtenir des joueurs » pour le nom de la requête :
      Nom de la demande
      Nom de la demande
    4. Cliquez sur Créer une collection, puis entrez « API de gestion du lecteur » pour le nom de la collection :
      Créer une collection de demandes
      Créer une collection de demandes
    5. Enregistrez la collection.
    6. Recherchez la collection d'API Player Management dans la liste de gauche et cliquez dessus pour ouvrir votre nouvelle demande :
      Collection d'API de gestion des lecteurs
      Collection d'API de gestion des lecteurs
    7. Accédez à l'onglet Autorisation , choisissez OAuth 2.0 comme type et assurez-vous que l'option Ajouter des données d'autorisation aux en-têtes de requête est sélectionnée :
      Section des autorisations
      Section des autorisations
    8. Cliquez sur Obtenir un nouveau jeton d'accès:
      Obtenir un nouveau jeton d'accès
      Obtenir un nouveau jeton d'accès
    9. Dans la boîte de dialogue, entrez les informations suivantes :
      • Nom du jeton: API de gestion des lecteurs
      • Type de subvention: Informations d'identification client
      • URL du jeton d'accès : https://oauth.brightcove.com/v4/access_token
      • ID client : (entrez votre identifiant client)
      • Client Secret : (entrez votre secret client)
      • Portée : (laisser vide)
      • Authentification client: Envoyer les informations d'identification client dans le corps
      Boîte de dialogue Get d'accès
      Boîte de dialogue Get d'accès
    10. Cliquez sur Demander un jeton
    11. Vous devriez voir apparaître un nouveau jeton d'accès :
      Nouveau jeton d'accès
      Nouveau jeton d'accès

    Envoyer la GET demande

    Maintenant, nous sommes prêts à faire des requêtes API.

    Faire une GET demande

    1. Saisissez maintenant l'URL suivante dans le champ Entrer l'URL de la demande , en remplaçant votre identifiant de compte par {account_id} :
      	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
      	
      	
      Entrez l'URL de la demande
      Entrez l'URL de la demande
    2. Laissez la méthode sous forme GET, puis cliquez sur Envoyer:
      Obtenir la demande
      GET Demande
    3. La réponse devrait ressembler à ceci :
      Réponse GET
      Réponse GET

    Envoyer la POST demande

    Maintenant, nous allons envoyer une POST demande avec quelques données. Dans ce cas, nous allons créer un nouveau joueur à l'aide de l'API Player Management.

    Faire une POST demande

    1. Dupliquez votre demande Get Players :
      Demande en double
      Demande en double
    2. Ouvrez votre nouvelle demande et renommez-la « Create Player »
      Renommer la demande
      Renommer la demande
    3. Utilisez la même URL que vous l'avez fait pour les étapes de GET requête ci-dessus, mais choisissez maintenant POST d'être la méthode HTTP sélectionnée.
      Demande de poste
      POST Demande
    4. Cliquez sur l'onglet Corps juste sous l'URL, puis choisissez le bouton radio brut et JSON (application/json) dans le menu déroulant type :
      Corps de demande
      Corps de demande
    5. Vous pouvez noter qu'un nouvel en-tête est automatiquement ajouté à la requête. Les requêtes qui envoient des données ont besoin d'un en-tête indiquant à l'API quel type de données sont envoyées. Cliquez sur l'onglet En-têtes pour afficher l' Content-Type: application/json en-tête :
      Ajouter un en-tête
      Ajouter un en-tête
    6. Pour les données brutes, entrez le code JSON suivant pour le corps (la capture d'écran suivant le JSON montre comment la requête doit apparaître) :
      	{
              "name": "Postman Test Player"
              }
      	
    7. Cliquez sur Envoyer.
    8. Votre réponse ressemblera à ce qui suit (Vous pouvez cliquer sur le bouton Jolie pour JSON plus joliment formaté) :

      Réponse POST
      Réponse POST
    9. Vous pouvez vérifier que votre lecteur a été créé en consultant la section Lecteurs de Studio.

    Variables d'environnement

    Bien que vous puissiez créer des informations d'identification client pour plusieurs comptes et n'importe quelle combinaison d'opérations API, vous pouvez maintenir une plus grande sécurité en limitant la portée de vos informations d'identification à un seul compte et API (ou même à des opérations d'API spécifiques). Si c'est le cas, vous pouvez tirer Postmanparti des variables d'environnement pour simplifier les requêtes de test sur plusieurs comptes et API. La clé consiste à configurer les environnements correspondant à chaque jeu d'informations d'identification client que vous utilisez.

    Voici les étapes de création et d'utilisation des variables d'environnement pour client_id et client_secret .

    1. Cliquez sur le menu engrenage en haut à droite Postman et sélectionnez Gérer les environnements.
      Menu Environnements
      Menu Environnements
    2. Dans la boîte de dialogue Gérer les environnements , cliquez sur Ajouter pour ajouter un environnement.
    3. Pour le nouvel environnement, entrez :
      • Un nom (APIS Brightcove, ou ce que vous voulez)
      • Variable d'environnement appelée account_id avec une valeur de votre identifiant de compte
      • Une variable d'environnement appelée client_id avec une valeur de votre identifiant client
      • Une variable d'environnement appelée client_secret avec une valeur de votre secret client
      Ajouter des variables d'environnement
      Ajouter des variables d'environnement
    4. Cliquez sur Ajouter pour ajouter l'environnement
    5. Fermez la boîte de dialogue Gérer les environnements pour revenir à votre environnement Postman et sélectionner votre environnement dans le menu.
      Sélectionner un environnement
      Sélectionner un environnement
    6. Vous pouvez maintenant commencer à remplacer les valeurs codées en dur dans vos requêtes par des variables. Pour ce faire, il suffit de taper {{ n'importe où, et une liste déroulante de variables apparaîtra :
      Utiliser les variables d'environnement
      Utiliser les variables d'environnement

    Créer une collection à partir d'une référence API

    À partir de la version 6.7.4, Postman prend en charge l'importation des spécifications OpenAPI pour créer des collections de requêtes. Étant donné que les références API de la plate-forme de Brightcove sont basées sur la spécification OpenAPI, vous pouvez utiliser cette fonctionnalité pour générer une collection complète de requêtes pour l'une des API Brightcove.

    Dans les étapes ci-dessous, nous utiliserons le Dynamic Ingest API comme exemple, mais la procédure fonctionnera pour l'une des API de la plate-forme Brightcove (pas pour l'API Player ou les SDK mobiles, car Postman ne prend en charge que les API REST).

    Étapes

    1. Dans votre navigateur, accédez à Dynamic Ingest API Reference
    2. Cliquez sur le Download bouton sous le titre pour télécharger le OpenAPI specification pour l'API :
      Télécharger la spécification OpenAPI
      Télécharger la spécification OpenAPI
    3. Selon le navigateur que vous utilisez, la spécification (un fichier YAML) peut être téléchargée ou ouverte dans un nouvel onglet de navigateur. S'il s'ouvre dans le navigateur, copiez et collez le contenu dans un fichier texte ou enregistrez la source de la page sur votre lecteur local. Le fichier doit être nommé openapi.yaml.
    4. Maintenant, allez Postman et cliquez sur le Import bouton en haut de la fenêtre sur le côté gauche :
      Bouton Importation Facteur
      Bouton Importation Facteur
    5. Faites glisser et déposez le openapi.yaml fichier de votre gestionnaire de fichiers dans le modal d'importation qui s'ouvre :
      Facteur Import Modal
      Facteur Import Modal
    6. Après le Postman traitement du fichier, vous verrez une nouvelle collection dans la liste intitulée Dynamic Ingest API Reference
      Nouvelle collection Facteur
      Nouvelle collection Facteur
    7. Drilldown dans les dossiers à travers accounts/{account id}/video/{video id} et vous verrez les requêtes :
      Drilldown vers les requêtes
      Drilldown vers les requêtes
    8. Sélectionnez la POST demande pour l'ouvrir. Vous trouverez à la fois le Params et le Body pré-rempli à partir de la référence API, mais vous devrez remplacer les espaces réservés qui montrent le type de données par des données réelles :
      Params préremplis
      Params préremplis
      Corps prépeuplé
      Corps prépeuplé
    9. Une fois que vous avez remplacé les espaces réservés par des valeurs appropriées, vous pouvez utiliser la requête comme celles que vous avez créées vous-même.