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

Utiliser l'insomnie pour les demandes d'API

Dans cette rubrique, vous apprendrez à configurer le client HTTP Insomnia populaire pour effectuer des requêtes auprès des API Brightcove RESTful.

Introduction

Certains trouvent que les instructions curl et la ligne de commande, utilisées pour de nombreux exemples dans la documentation de nos API de plateforme, 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 outil populaire, le Insomnia app.

installer Insomnia

Obtenez un Insomnia . https://insomnia.rest. Insomnia peut être installé sur les systèmes Mac, Linux ou Windows.

Insomnia peut être utilisé pour effectuer des demandes auprès de n'importe quelle API RESTful de Brightcove. La plupart des API utilisent OAuth2 pour l'authentification, et c'est ce que nous allons démontrer dans ce document. Cependant, vous pouvez également l'utiliser pour les API qui n'utilisent pas OAuth, en définissant simplement l'en-tête approprié.

Définir l'en-tête dans l'insomnie
Définir l'en-tête Insomnia

Voici à quoi ressemblera cet en-tête pour les requêtes avec différentes méthodes d'authentification:

OAuth API (créer une demande d'informations d'identification uniquement.)
  Authorization: BC_TOKEN YOUR_BC_TOKEN

Comment obtenir votre BC_TOKEN.

Playback API
  BCOV-Policy: YOUR_POLICY_KEY
Live API
  X-API-KEY: YOUR_API_KEY
Zencoder API
  Zencoder-Api-Key: YOUR_API_KEY

Obtenir les informations d'identification du client

Pour fonctionner avec la plupart des 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 allons faire Player Management API demandes utilisant Insomnia, vos identifiants doivent avoir au moins les autorisations suivantes:

  • des joueurs: Lire écrire

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 pouvez obtenir des informations d'identification qui fonctionneront pour plusieurs comptes si vous le souhaitez.

En utilisant Insomnia

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

Mise en place d'un Insomnia espace de travail

Si vous travaillez avec d'autres API, vous souhaiterez peut-être créer un espace de travail uniquement pour les demandes Brightcove.

  1. Lancez l' Insomnia app.
  2. Cliquez sur le menu déroulant à côté Insomnia et sélectionnez Nouvel espace de travail:
    Créer un espace de travail
    Insomnia Section d'autorisation
  3. Entrez le nom Brightcove et cliquez sur Créer:
    Nom Espace de travail
    Type d'autorisation
  4. Cliquez signe plus et sélectionnez Nouveau dossier:
    Créer un nouveau dossier
    Créer un nouveau dossier
  5. Donnez votre nom à votre dossier Player Management API

Envoyer GET nécessaire

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

Faire un GET nécessaire

  1. Cliquez sur l'icône du menu déroulant dans votre nouveau dossier, puis sélectionnez Nouvelle requête:
    Nouvelle requête
    Nouvelle requête
  2. Donnez le nom à la demande Avoir tout Players, laissez la méthode HTTP comme GET, et cliquez sur créer.
  3. Remplacez l'URL de requête générique par:
      https://players.api.brightcove.com/v2/accounts/account_id/players

    remplacer identifiant de compte avec votre propre identifiant de compte:

    Nouvelle requête
    Nouvelle requête
  4. Élargir la Auth menu déroulant et sélectionnez OAuth 2.0:
    Menu Auth
    Menu Auth
  5. Pour le Type de subvention, Sélectionnez Informations d'identification du client:
    Type de subvention
    Type de subvention
  6. Entrez des valeurs pour l'URL du jeton d'accès, l'ID client et le secret client:
    Entrées OAuth
    URL du jeton d'accès https://oauth.brightcove.com/v4/access_token
    identité du client votre identifiant client
    Secret client votre secret client
  7. Cliquez Récupérer des jetons pour s'assurer que cela fonctionne. Vous devriez voir une réponse comme celle-ci:
    Jeton d'accès
    Jeton d'accès
  8. Cliquez Envoyer:
    GET Demande
    GET Demande
  9. La réponse devrait ressembler à ceci:
    Avoir une réponse
    GET 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 nouvel objet vidéo en utilisant le Player Management API.

Pour ce faire, nous dupliquerons Avoir tout Players demander et modifier selon nos besoins. Une autre fonctionnalité intéressante de Insomnia est que lorsque vous dupliquez une demande, toutes les informations d'authentification sont dupliquées avec elle, vous n'avez donc pas à configurer la récupération des jetons d'accès.

Faire un POST nécessaire

  1. Clique sur le Player Management API dossier pour montrer le Avoir tout Players demande à l'intérieur.
  2. Développez le menu déroulant pour le Avoir tout Players demander et sélectionner Dupliquer:
    Demande en double
    Demande en double
  3. Double-cliquez sur le nom Avoir tout Players (Copie) et changer pour Créer Player
  4. Utilisez la même URL que pour les étapes de demande GET ci-dessus, mais choisissez maintenant POST être la méthode HTTP sélectionnée.
    Changer Methdo
    Changer la méthode
  5. Cliquez Bodys Harnais pour développer le menu déroulant et sélectionner JSON:
    Sélectionnez le type de carrosserie
    Sélectionnez le type de carrosserie
  6. Pour le Bodys Harnais data, entrez le code JSON suivant pour le corps (la capture d'écran suivant le JSON montre comment la requête doit apparaître):
      {
      "name": "MySamplePlayer",
          "configuration": {
              "media": {
              "sources": [{
                  "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                  "type":"video/mp4"
                  }]
              }
          }
      }
      
      
      {
          "name": "MySamplePlayer",
          "configuration": {}
      }
      
      
    Corps de la demande
    Corps de la demande
    Corps de la demande
    Corps de la demande
  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
    POST Réponse
  9. Vous pouvez vérifier que votre player a été créé en archivant le Playermodule s dans Studio.

Variables d'environnement

Vous trouverez peut-être utile d'utiliser Insomnia's Environnements pour enregistrer les informations d'identification OAuth pour différentes API, ou pour enregistrer d'autres informations telles que l'identifiant de votre compte et la vidéo ou player ids.

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

  1. Cliquez Aucun environnement dans la partie supérieure gauche de Insomnia pour développer le menu déroulant et sélectionner Gérer les environnements.
    Menu des environnements
    Menu des environnements
  2. Dans le Gérer les environnements dialogue, cliquez sur + signe à côté Sous-environnements pour développer le menu déroulant, et sélectionnez Environnement pour créer un nouvel environnement:
    Ajouter un environnement
    Ajouter un environnement
  3. Double-cliquez sur le Nouvel environnement nom pour le changer pour Player Management API (ou ce que vous voulez).
  4. A l'intérieur des accolades pour l'environnement JSON, ajoutez ces paires clé-valeur:
    • "account_id""l'identifiant de votre compte"
    • "client_id""votre identifiant client"
    • "client_secret""votre secret client"

    Lorsque vous avez terminé, le JSON devrait ressembler à ceci:

    Ajouter un environnement JSON
    Ajouter un environnement JSON

    (Le secret client ici est flou pour des raisons de sécurité.)

  5. Cliquez Terminé ajouter l'environnement
  6. Cliquez Pas d'environnement à nouveau pour développer la liste déroulante, et sélectionnez Utilisez Player Environnement de gestion (ou quel que soit le nom que vous avez donné au nouvel environnement):
    Sélectionnez l'environnement
    Sélectionnez l'environnement
  7. Maintenant, sélectionnez le Avoir tout Players demande à nouveau de le rouvrir.
  8. Cliquez OAuth 2 rouvrir la section d'authentification.
  9. Supprimez la valeur de l'ID du client et commencez à taper client_id - vous verrez apparaître un menu déroulant montrant les variables d'environnement pertinentes, où vous devriez sélectionner client_id:
    Variables d'environnement Dropdown
    Variables d'environnement Dropdown
  10. Maintenant, sélectionnez le identifiant de compte dans l'URL de la requête, et remplacez-le par identifiant de compte variable.
  11. Faites la même chose pour remplacer le Secret client valeur avec le client_secret variable.
  12. Maintenant, cliquez sur Envoyer encore une fois pour s'assurer que la demande fonctionne toujours.

Conclusion

Vous connaissez maintenant les bases de l'utilisation Insomnia pour faire des demandes aux API Brightcove. Notez que si vous choisissez de mettre à jour votre Insomnia compte à un compte d'équipe, vous pouvez également synchroniser toutes vos demandes et environnements et les partager avec d'autres membres de l'équipe.


Dernière mise à jour de la page le 12 juin 2020