Paper Contacter le support | état du système L'état du système
Contenu de la page

    Domaine de pratique: CMS API

    Dans cette rubrique, vous apprendrez comment utiliser le CMS API en examinant certains des types de demande courants et les données qu’ils renvoient.

    Vue d'ensemble

    Ce démarrage rapide vous aidera à vous familiariser avec les opérations disponibles via CMS API. le CMS API active différentes opérations sur 30. Ce didacticiel ne couvre donc pas toutes les opérations mais vous permet de tester certaines des opérations les plus utilisées pour voir le type de données qu’elles renvoient.

    Obtenir des informations d'identification

    Comme la plupart des API RESTful de Brightcove, le CMS API a besoin OAuth jetons d'accès pour autoriser les requêtes. Pour obtenir des jetons d'accès, vous devez d'abord obtenir les informations d'identification du client avec les 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 à ici. Le proxy accède aux informations d'identification du client à partir d'un emplacement privé et les utilise pour générer un jeton d'accès temporaire à l'aide du OAuth API puis effectue la demande d'API et renvoie les données de réponse.

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

    1. Pour obtenir vos informations d'identification, suivez les instructions Gestion des informations d'identification de l'API. C'est le moyen recommandé d'obtenir les informations d'identification de votre client. Dans la plupart des cas, vous souhaiterez probablement obtenir toutes les autorisations:
      Autorisations OAuth
      Autorisations OAuth

      Vous pouvez également obtenir des informations d'identification en utilisant OAuth API, en suivant les instructions de l’un des guides énumérés ci-dessous. Les éléments suivants peuvent être utilisés avec curl ou Postman pour obtenir les autorisations appropriées:

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

    CodePen

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

    Code Source

    Trouver tout le code associé à cet exemple dans cette GitHub référentiel.

    Exemple d'application

    Voir le stylo CMS API Quick Start par 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 Le résultat .
    • Cliquez HTML / CSS / JS boutons pour afficher l'un des types de code.
    • Cliquez Modifier sur CodePen dans le coin supérieur droit pour bifurquer ce CodePen dans votre propre compte.
    • Trouver tout le code associé à cet exemple dans cette GitHub référentiel.

    Code de proxy

    Pour créer votre propre version de l'exemple d'application sur cette page, vous devez créer et héberger votre propre proxy. (Les proxys 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 vérifications qui bloquent les demandes des domaines non Brightcove, se trouve dans ce dépôt GitHub. Vous y trouverez également des instructions de base pour l’utiliser, ainsi qu’un guide plus élaboré sur la création d’applications autour du proxy dans Utilisation des API REST.


    Dernière mise à jour de la page le 24 août 2020