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
Retrouvez tout le code associé à cet exemple dans ce référentiel GitHub.
Exemple d'application
Voir le stylo Démarrage rapide de l'API CMS par Brightcove Learning Services (@rcrooks1969 ) au Stylo de code.
Aperçu
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 d'identification
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 les informations d'identification du 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 identifiants client et utilisez l'un de nos Outils de test d'API.
- Pour obtenir vos identifiants, suivez les instructions dans Gestion des informations d'identification de l'API. Il s'agit de la méthode recommandée pour obtenir vos informations d'identification client. Dans la plupart des cas, vous souhaiterez probablement obtenir toutes les autorisations :
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. Les éléments suivants peuvent être utilisés avec curl ou Postman pour obtenir les autorisations appropriées :
"operations": ["video-cloud/video/all"]
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 bouton.
- Clique le HTML/CSS/JS pour afficher UN des types de code.
- Cliquez sur Modifier sur CodePen dans le coin supérieur droit pour insérer ce CodePen dans votre propre compte.
- Retrouvez tout le code associé à cet exemple dans ce référentiel GitHub.
Code proxy
Afin de créer 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 n'acceptent que 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 y trouverez également des instructions de base pour l'utiliser, ainsi qu'un guide plus détaillé sur la création d'applications autour du proxy dans Utilisation des API REST.