サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    練習領域:CMS API

    このトピックでは、を開始する方法を学習しますCMS API一般的なリクエストタイプのいくつかとそれらが返すデータを確認します。

    概要

    このクイックスタートは、を介して利用可能な操作に慣れるために役立ちますCMS API。ザ・CMS API 30を超えるさまざまな操作が可能であるため、このチュートリアルではそれらすべてを網羅しているわけではありませんが、代わりに、最も一般的に使用される操作のいくつかをテストして、それらが返すデータの種類を確認できます。

    資格情報を取得する

    BrightcoveのRESTfulAPIのほとんどと同様に、CMS APIが必要OAuthトークンにアクセスしてリクエストを承認します。アクセストークンを取得するには、まず、要求する操作の種類に対するアクセス許可を持つクライアント資格情報を取得する必要があります。このクイックスタートでは、Brightcove ラーニングサービスのサンプルアカウントで API リクエストを行うため、ここで認証情報を取得する必要はありませんが、何が起こっているのかを理解しておく必要があります。ザ・CodePen次のようなプロキシにAPIリクエスト情報を送信しますこれです。プロキシはプライベートな場所からクライアントの資格情報にアクセスし、それらを使用して一時的なアクセストークンを生成します。OAuth API次に、APIリクエストを作成し、レスポンスデータを返します。

    自分のアカウントでリクエストを試すには、クライアントの資格情報を取得して、 APIテストツール

    1. 認証情報を取得するには、「 API 認証情報の管理」の手順に従います。これは、クライアントの資格情報を取得するための推奨方法です。ほとんどの場合、すべてのアクセス許可を取得する必要があります。
      OAuth パーミッション
      OAuth パーミッション

      を使用して資格情報を取得することもできますOAuth API、以下のいずれかのガイドの指示に従ってください。以下をcurlまたはPostmanとともに使用して、適切な権限を取得できます。

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

    CodePen

    以下のCodePenを使用して、さまざまなテストを行ってくださいCMS APIリクエストを送信し、リクエストと応答データがどのように表示されるかを確認します。

    ソースコード

    このサンプルに関連付けられているすべてのコードを、この GitHub リポジトリで検索します

    サンプルアプリ

    ペンを見るCMSAPIクイックスタート Brightcove Learning Services( @ rcrooks1969) オンCodePen

    CodePen を使用する

    上記のCodePenを効果的に使用するためのヒントは次のとおりです。

    • [ 結果 ] ボタンをクリックして、アプリの実際の表示を切り替えます。
    • HTML/CSS/JS ボタンをクリックして、コードタイプの 1 つを表示します。
    • 右上隅にある CodePen の編集をクリックして、この CodePen を自分のアカウントにフォークします。
    • このサンプルに関連付けられているすべてのコードを、この GitHub リポジトリで検索します

    プロキシコード

    このページのサンプルアプリを独自のバージョンで作成するには、独自のプロキシを作成してホストする必要があります。(Brightcove ラーニングサービスで使用されるプロキシは、Brightcove のドメインからのリクエストのみを受け付けます)。サンプルプロキシは、私たちが使用しているものと非常に似ていますが、BrightCove 以外のドメインからのリクエストをブロックするチェックがないサンプルプロキシは、この GitHub リポジトリにあります。また、そこで使用するための基本的な手順と、 REST API の使用で説明されているプロキシの周りにアプリを構築するためのより精巧なガイドがあります。