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

    Utiliser l'Insomnie pour les requêtes API

    Dans cette rubrique, vous apprendrez comment configurer le client HTTP Insomnia populaire pour faire des requêtes aux API RESTful de Brightcove.

    Introduction

    Certains trouvent des instructions curl et la ligne de commande, utilisées pour de nombreux exemples dans la documentation des API de notre plate-forme, difficiles et intimidantes. 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 outil populaire, l' Insomnia application.

    Installer Insomnia

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

    Insomnia peut être utilisé pour effectuer des requêtes à l'une des API RESTful de Brightcove. La plupart des API utilisent OAuth2 pour l'authentification, et c'est ce que nous montrerons 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 dans 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
    API Zencoder
      Zencoder-Api-Key: YOUR_API_KEY

    Obtenir les identifiants client

    Pour travailler 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 de la page Gestion des informations d'identification d'authentification API. Dans les étapes ci-dessous, nous ferons des Player Management API demandes à l'aide Insomnia , de sorte que vos informations d'identification doivent avoir au moins les autorisations suivantes :

    • Joueurs: Lecture/écriture

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

    Utilisation de Insomnia

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

    Configuration d'un Insomnia espace de travail

    Dans le cas où vous travaillez avec d'autres API, vous pouvez créer un espace de travail uniquement pour les requêtes Brightcove.

    1. Lancez l' Insomnia application.
    2. Cliquez sur la liste déroulante en regard Insomnia et sélectionnez Nouvel espace de travail:
      Créer un espace de travail
      Insomnia Section des autorisations
    3. Entrez le nom Brightcove et cliquez sur Créer:
      Nom de l'espace de travail
      Type d'autorisation
    4. Cliquez sur le signe plus et sélectionnez Nouveau dossier:
      Créer un nouveau dossier
      Créer un nouveau dossier
    5. Donnez le nom à votre dossier Player Management API

    Envoyer la GET demande

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

    Faire une GET demande

    1. Cliquez sur l'icône du menu déroulant de votre nouveau dossier, puis sélectionnez Nouvelle demande:
      Nouvelle demande
      Nouvelle demande
    2. Donnez à la requête le nom Get All Players, laissez la méthode HTTP sous la forme GET, puis 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

      Remplacez account_id par votre propre identifiant de compte :

      Nouvelle demande
      Nouvelle demande
    4. Développez le menu déroulant Auth et sélectionnez OAuth 2.0:
      Menu Auth
      Menu Auth
    5. Pour le type d'autorisation, sélectionnez Informations d'identification 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
      ID du client votre identifiant client
      Secret client votre secret client
    7. Cliquez sur Récupérer les jetons pour vous assurer que cela fonctionne. Vous devriez voir une réponse comme ceci :
      Clé d'accès
      Clé d'accès
    8. Cliquez sur Envoyer:
      Demande GET
      GET Demande
    9. La réponse devrait ressembler à ceci :
      Réponse GET
      GET Réponse

    Envoyer la POST demande

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

    Pour ce faire, nous dupliquerons la demande Get All Players et modifierons si nécessaire. Une autre caractéristique intéressante de Insomnia est que lorsque vous dupliquez une demande, toutes les informations d'authentification sont dupliquées avec elle, de sorte que vous n'aurez pas à configurer l'obtention de jetons d'accès à nouveau.

    Faire une POST demande

    1. Cliquez sur le dossier API Player Management pour afficher la demande Obtenir tous les joueurs à l'intérieur.
    2. Développez le menu déroulant de la demande Obtenir tous les joueurs et sélectionnez Dupliquer:
      Demande en double
      Demande en double
    3. Double-cliquez sur le nom Obtenir tous les joueurs (Copier) et modifiez-le en Create Player
    4. Utilisez la même URL que vous l'avez fait pour les étapes de requête GET ci-dessus, mais choisissez maintenant POST d'être la méthode HTTP sélectionnée.
      Changer Methdo
      Change, méthode
    5. Cliquez sur le corps pour développer le menu déroulant et sélectionnez JSON:
      Sélectionner le type de corps
      Sélectionner le type de corps
    6. Pour les données Body , 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 demande
      Corps de demande
      Corps de demande
      Corps de demande
    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
      POST Réponse
    9. Vous pouvez vérifier que votre lecteur a été créé en enregistrant le module Players dans Studio.

    Variables d'environnement

    Vous trouverez peut-être utile d’utiliser Insomniade Environnements pour enregistrer les informations d'identification OAuth pour différentes API, ou pour enregistrer d'autres informations telles que votre identifiant de compte et vos identifiants vidéo ou de lecteur.

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

    1. Cliquez sur Aucun environnement dans la zone supérieure gauche de Insomnia pour développer le menu déroulant et sélectionnez Gérer les environnements.
      Menu Environnements
      Menu Environnements
    2. Dans la boîte de dialogue Gérer les environnements , cliquez sur le signe + en regard des sous-environnements pour développer le menu déroulant, puis sélectionnez Environnement pour créer un nouvel environnement :
      Ajouter un environnement
      Ajouter un environnement
    3. Double-cliquez sur le nom du nouvel environnement pour le changer en API Player Management (ou ce que vous voulez).
    4. Dans les accolades pour l'environnement JSON, ajoutez ces paires clé-valeur :
      • "account_id": "votre identifiant de 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 floue pour des raisons de sécurité.)

    5. Cliquez sur Terminé pour ajouter l'environnement
    6. Cliquez à nouveau sur Aucun environnement pour développer la liste déroulante, puis sélectionnez Utiliser l'environnement de gestion du lecteur (ou quel que soit le nom que vous avez donné au nouvel environnement) :
      Sélectionner l'environnement
      Sélectionner l'environnement
    7. Maintenant, sélectionnez à nouveau la demande Obtenir tous les joueurs pour la rouvrir.
    8. Cliquez sur OAuth 2 pour rouvrir la section Authentification.
    9. Supprimez la valeur de l'identifiant client et commencez à taper client_id - vous verrez apparaître un menu déroulant affichant les variables d'environnement pertinentes, où vous devez sélectionner client_id:
      liste déroulante des variables d'environnement
      liste déroulante des variables d'environnement
    10. Sélectionnez maintenant l' ID du compte dans l'URL de la demande et remplacez-le par la variable account_id .
    11. Faites la même chose pour remplacer la valeur Client Secret par la variable client_secret .
    12. Maintenant, cliquez à nouveau sur Envoyer pour vous assurer que la demande fonctionne toujours.

    Conclusion

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