Media API テストツール

今回は Media API のテストをするのに非常に便利なツール「API Test Tool」をご紹介します。
このツールを使うと Media API の各メソッドを簡単に実行することができて、また結果も見やすいツリー形式で表示してくれます。

■ 準備
ダウンロードはこちらから行えます。

ダウンロードした ZIP ファイルを解凍すると以下のファイルが生成されます。
※ その他実行に直接関係のないファイルも生成されますがそれらは省略します。

  • api-test-tool.css - CSS
  • api-test-tool.js - Media API ツールの本体 (JavaScript)
  • index.html - HTML
  • json2.js - JSON 用ヘルパーライブラリ (JavaScript)

このツールは米国アカウント用に作られているため、日本アカウントでご利用になる場合には一部変更が必要となります。
ZIP ファイルを解凍後、解凍されたファイルから api-test-tool.js をテキストエディタで開いてください。

api-test-tool.js 内に以下の行があります。
var v = "http://api.brightcove.com/services/library?command=" + API_Test_Tool.method + "&" + u.substr(0, (u.length - 1)) + c + j;

上記を以下のように修正してください。
var v = "http://api.brightcove.co.jp/services/library?command=" + API_Test_Tool.method + "&" + u.substr(0, (u.length - 1)) + c + j;

以上で準備完了です。
 

■ 利用方法

解凍したファイルを同一ディレクトに入れた状態で index.html をブラウザで直接開くことで利用ができます。
※ 上記ファイルをサーバーでホストすることでオンラインでの利用も可能です。

index.html をクリックすると以下の画面が表示されます。

ページの左上のドロップダウンメニューにはこのツールで利用できる Media API のメソッド一覧が含まれています。メソッドは VIDEO と PLAYLIST のメディアタイプ別にグループされています。

Media API のメソッドを実行するには実行したいメソッドをドロップダウンメニューから選択します。するとドロップダウンメニュー下の左カラムに選択したメソッドに応じたフォームが表示されます。ここに表示されるフォームは選択中のメソッドに応じて変わり、選択中のメソッドで利用可能なパラメータの設定フィールドが表示されます。これにより選択したメソッドでどのパラメータが利用可能なのかがわかります。 どのメソッドにも token フィールドがあり、ここにはご利用のアカウントの読み取りトークンを入力してください。
※ 読み取りトークンの取得の詳細はここから確認できます。
動画の URL(FLVURL フィールドなど)を取得する場合には URL アクセスのある読み取りトークンを利用してください。

フォーム上のパラメータの値を変更するたびに、選択したメソッドの結果が右カラムの "RETURN" という欄にツリー形式で表示されます。結果を見やすくするために各セクションは折りたたむことができます。

またページ上部には Media API のメソッド発行用のURLが表示されます。この URL を直接ブラウザなどに入力することで生の結果 (JSON/MRSS) を得ることもできます。

Media API の動作を評価したり、Video Cloud 管理画面からは見えない動画情報をみるのにとても便利なツールです。是非ご活用ください。