Paper Contacter le support | état du système L'état du système

Utiliser Postman pour les demandes d'API

Dans cette rubrique, vous apprendrez à configurer le client HTTP Postman populaire pour effectuer des requêtes auprès des API Brightcove RESTful. Certains trouvent que les instructions curl et la ligne de commande, utilisées pour la plupart des exemples de cette section de la documentation, sont difficiles et intimidantes. Pour ceux-ci, il existe de nombreux outils pour envoyer des requêtes HTTP aux services basés sur REST, qui incluent la plupart des API Brightcove. Ce document vous montrera comment utiliser un tel outil, l'application Postman.

installer Postman

Obtenez un Postman . 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 de Chrome fonctionnera sur n’importe quelle plate-forme et ses fonctionnalités et son apparence seront identiques.

Obtenir les informations d'identification du 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 vos informations d'identification client dans Studio en suivant les instructions Gestion des informations d'identification de l'API. Dans les étapes ci-dessous, nous ferons Player Management API demandes utilisant Postman, vos identifiants doivent avoir au moins les autorisations suivantes:

  • Players: Read/Write

Vous pouvez ajouter autant d'autorisations que vous le souhaitez pour obtenir des informations d'identification qui seront utilisables pour un plus grand nombre de demandes d'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 tu préfères. Si vous le faites, vous devez spécifier au moins video-cloud/player/all autorisations

En utilisant Postman

Une fois que vous avez vos informations d'identification client, vous êtes prêt à commencer à utiliser Postman. Les étapes ci-dessous vous guideront dans la réalisation de Player Management API demandes utilisant Postman.

Mise en place Postman pour obtenir des jetons d'accès

  1. Lancez l' Postman app.
  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, saisissez "Obtenir Players "pour le nom de la demande:
    Nom de la demande
    Nom de la demande
  4. Cliquez sur Créer une collection, puis entrez "Player Management API"pour le nom de la collection:
    Créer une collection de requêtes
    Créer une collection de requêtes
  5. Sauvegardez la collection.
  6. Trouvez le Player Management API collection dans la liste de gauche et cliquez dessus pour ouvrir votre nouvelle requête:
    Player Management API Collection
    Player Management API Collection
  7. Allez à Autorisation Cliquez sur l'onglet, choisissez le type OAuth 2.0 et assurez-vous que l'option Ajouter des données d'autorisation aux en-têtes de requête est sélectionnée:
    Section d'autorisation
    Section d'autorisation
  8. Cliquez 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: Player Management API
    • Type de subvention: Informations d'identification client
    • URL du jeton d'accès: https://oauth.brightcove.com/v4/access_token
    • identité du client: (entrez votre identifiant client)
    • Secret client: (entrez votre secret client)
    • Portée: (laisser vide)
    • Authentification du client: Envoyer les informations d'identification du client dans le corps
    Obtenir une boîte de dialogue de jeton d'accès
    Obtenir une boîte de dialogue de jeton d'accès
  10. Cliquez Demande de jeton
  11. Vous devriez voir apparaître un nouveau jeton d'accès:
    Nouveau jeton d'accès
    Nouveau jeton d'accès

Envoyer GET nécessaire

Nous sommes maintenant prêts à faire des demandes d'API.

Faire un GET nécessaire

  1. Entrez maintenant l'URL suivante dans le Entrez l'URL de la requête 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 en tant que GETEt cliquez Envoyer:
    Obtenir une demande
    GET Demande
  3. La réponse devrait ressembler à ceci:
    Avoir une réponse
    Avoir une réponse

Envoyer POST nécessaire

Maintenant, nous allons envoyer un POST demande avec quelques données. Dans ce cas, nous allons créer un nouveau player utilisant l' Player Management API.

Faire un POST nécessaire

  1. Dupliquez votre Get Players demande:
    Demande en double
    Demande en double
  2. Ouvrez votre nouvelle demande et renommez-la "Créer Player"
    Renommer la demande
    Renommer la demande
  3. Utilisez la même URL que vous avez fait pour le GET demander les étapes ci-dessus, mais choisissez maintenant POST être la méthode HTTP sélectionnée.
    Demande de poste
    POST Demande
  4. Cliquez Bodys Harnais onglet juste sous l'URL, puis choisissez le brut bouton radio et JSON (application / json) dans le menu déroulant Type:
    Corps de la demande
    Corps de la demande
  5. Vous pouvez noter qu'un nouvel en-tête est automatiquement ajouté à la demande. Les demandes qui envoient des données ont besoin d'un en-tête indiquant à l'API le type de données envoyé. Clique le En-têtes onglet pour voir le 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 Envoyer.
  8. Votre réponse ressemblera à ce qui suit (vous pouvez cliquer sur Assez bouton pour JSON plus joliment formaté):

    Réponse POST
    Réponse POST
  9. Vous pouvez vérifier que votre player a été créé en archivant le Playersection s de Studio.

Variables d'environnement

Bien que vous puissiez créer des informations d'identification client pour plusieurs comptes et toute combinaison d'opérations d'API, vous souhaiterez peut-être renforcer la sécurité en limitant la portée de vos informations d'identification à un seul compte et à une API (ou même à des opérations d'API spécifiques). Si oui, vous pouvez profiter de Postman's Variables d'environnement simplifier les demandes de test sur plusieurs comptes et API. La clé consiste à configurer des environnements correspondant à chaque ensemble d'informations d'identification client que vous utilisez.

Voici les étapes pour créer et utiliser des variables d'environnement pour le client_id et client_secret .

  1. Cliquez sur le menu d'engrenage en haut à droite Postman et sélectionnez Gérer les environnements.
    Menu des environnements
    Menu des environnements
  2. Dans le Gérer les environnements dialogue, cliquez sur Ajoutez ajouter un environnement
  3. Pour le nouvel environnement, entrez:
    • Un nom (Brightcove APIS, ou ce que vous voulez)
    • Une variable d'environnement appelée account_id avec la valeur de l'identifiant de votre 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 Ajoutez ajouter l'environnement
  5. Fermer la Gérer les environnements dialogue pour revenir à Postman et sélectionnez votre environnement dans le menu.
    Sélectionnez un environnement
    Sélectionnez un environnement
  6. Vous pouvez maintenant commencer à remplacer les valeurs codées en dur dans vos requêtes par des variables. Pour ce faire, tapez simplement {{ 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 de spécifications OpenAPI pour créer des collections de demandes. Étant donné que les références d'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 demandes pour l'une des API de Brightcove.

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

Étapes

  1. Dans votre navigateur, allez à Dynamic Ingest API Référence
  2. Clique 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 à gauche:
    Bouton d'importation Postman
    Bouton d'importation Postman
  5. Glissez et déposez le openapi.yaml fichier de votre gestionnaire de fichiers dans le modal d'importation qui s'ouvre:
    Facteur d'importation Postman
    Facteur d'importation Postman
  6. Après Postman traite le fichier, vous verrez une nouvelle collection dans la liste intitulée Dynamic Ingest API Reference
    Nouvelle Collection Postman
    Nouvelle Collection Postman
  7. Détailler dans les dossiers à travers accounts/{account id}/video/{video id} et vous verrez les demandes:
    Analyse détaillée des demandes
    Analyse détaillée des demandes
  8. Sélectionnez le POST demande de l'ouvrir. Vous trouverez les deux Params et la Body pré-rempli à partir de la référence API, mais vous devrez remplacer les espaces réservés qui affichent le type de données avec les données réelles:
    Paramètres pré-remplis
    Paramètres pré-remplis
    Corps pré-rempli
    Corps pré-rempli
  9. Une fois que vous avez remplacé les espaces réservés par des valeurs appropriées, vous pouvez utiliser la demande comme celles que vous avez créées vous-même.

Dernière mise à jour de la page le 20 mars 2020