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

    Domaine d'entraînement : API CMS

    Dans cette rubrique, vous apprendrez comment commencer avec le CMS API en regardant certains types de demandes courantes et les données qu'ils retournent.

    Présentation

    Ce démarrage rapide vous aidera à vous familiariser avec les opérations disponibles via le CMS API. Le CMS API permet plus de 30 opérations différentes, de sorte que ce tutoriel ne couvre pas toutes les opérations, mais vous permet de tester certaines des plus couramment utilisées pour voir quel type de données ils retournent.

    Obtenir des informations

    Comme la plupart des API RESTful de Brightcove, le CMS API a besoin OAuth jetons d'accès pour autoriser les demandes. Pour obtenir des jetons d'accès, vous devez d'abord obtenir des informations d'identification client avec des autorisations pour les types d'opérations que vous souhaitez demander. Ce démarrage rapide effectue des demandes d'API sur un exemple de compte Brightcove Learning Services. Vous n'aurez donc pas besoin d'obtenir des informations d'identification ici, mais vous devez comprendre ce qui se passe. Le CodePen envoie les informations de demande d'API à un proxy similaire à celui-ci. Le proxy accède aux informations d'identification client à partir d'un emplacement privé et les utilise pour générer un jeton d'accès temporaire à l'aide de l' OAuth API et effectue ensuite la demande d'API et renvoie les données de réponse.

    Pour essayer des demandes sur votre propre compte, obtenez vos informations d'identification client et utilisez l'un de nos outils de test API.

    1. Pour obtenir vos informations d'identification, suivez les instructions de la section Gestion des informations d'identification API. C'est la façon recommandée d'obtenir vos informations d'identification client. Dans la plupart des cas, vous voudrez probablement obtenir toutes les autorisations :
      Autorisations OAuth
      Autorisations OAuth

      Vous pouvez également obtenir des informations d'identification à l'aide du OAuth API, en suivant les instructions de l'un des guides répertoriés ci-dessous. Ce qui suit peut être utilisé avec curl ou Postman pour obtenir les autorisations appropriées :

      "operations": ["video-cloud/video/all"]

    CodePen

    Utilisez le CodePen ci-dessous pour tester diverses CMS API requêtes et voir à quoi ressemblent la demande et les données de réponse.

    Code source

    Trouvez tout le code associé à cet exemple dans ce dépôt GitHub.

    Exemple d'application

    Consultez l' API Pen CMS Quick Start by Brightcove Learning Services (@rcrooks1969 ) sur CodePen.

    Utilisation du CodePen

    Voici quelques conseils pour utiliser efficacement le CodePen ci-dessus :

    • Basculez l'affichage réel de l'application en cliquant sur le bouton Résultat .
    • Cliquez sur les boutons HTML/CSS/JS pour afficher L'UN des types de code.
    • Cliquez sur Modifier sur CodePen dans le coin supérieur droit pour incorporer ce CodePen dans votre propre compte.
    • Trouvez tout le code associé à cet exemple dans ce dépôt GitHub.

    Code proxy

    Afin de construire votre propre version de l'exemple d'application sur cette page, vous devez créer et héberger votre propre proxy. (Les proxy utilisés par Brightcove Learning Services acceptent uniquement les demandes des domaines Brightcove.) Un exemple de proxy, très similaire à celui que nous utilisons, mais sans les contrôles qui bloquent les demandes provenant de domaines non-BrightCove, peut être trouvé dans ce dépôt GitHub. Vous trouverez également des instructions de base pour l'utiliser là-bas, ainsi qu'un guide plus élaboré pour créer des applications autour du proxy dans Utilisation des API REST.