■メディアAPI概要
メディアAPIはメディア（動画コンテンツ）関連の操作を、管理画面を利用せず、API経由で行うことができ、メタ情報の読み込みを行うReadAPIと、メタ情報の書き込みを行うWriteAPIに分けられます。ReadAPIではメタ情報を複数のパターンで取得することができ、WriteAPIでは、動画コンテンツのアップロード・削除や、メタ情報の編集を行うことができます。
■ReadAPI機能概要
■ReadAPI利用準備
ReadAPIを利用するための事前作業はありません。
■ReadAPIのシステム概要
ReadAPIは、リクエストパラメータを指定して、EQシステムにHTTPクエリを発行し、
JSON/Text形式のレスポンスを取得します。
機能詳細は以下の各マニュアルをご確認ください。
■WriteAPI機能概要
■WriteAPIの種類
| 項目名 | 機能 |
| 認証API | APIトークンを取得し、通信元がWriteAPIを利用可能か判断します。 利用可能と判断された場合認証キーを発行します。 |
| 動画アップロードAPI | 認証キーを取得後、動画コンテンツのアップロードを行います。 |
| メタ情報編集API | 認証キーを取得後、メタ情報の編集を行います。 |
| サムネイル変更API | 認証キーを取得後、動画コンテンツに対するサムネイルの更新を行います。 |
| ステータス確認API | 認証キーを取得後、アップロード（トランスコード）の進捗状況を確認します。 |
| 動画削除API | 認証キーを取得後、動画コンテンツの削除を行います。 |
■WriteAPI利用準備
WriteAPIを利用するためには、APIトークン情報の入手と、弊社にてアカウントの設定を行う必要があります。ご利用を希望する場合、下記2点をご確認の上、弊社担当営業までご連絡ください。
・EQアカウントに割り振られているAPIトークンの入手
APIトークンは、管理画面の「契約会社情報」に掲載しています。
・利用元のIP制限
WriteAPIを使用可能な通信元をホワイトリスト形式にて制限します。
使用を許可する利用元のIPを弊社担当営業までご連絡ください。
■WriteAPIでのアップロードについて
WriteAPIを利用したアップロードに関して、下記事項をご確認ください。
・動画ファイル、メタ情報のフォーマットについては、EQ管理画面での仕様制限と同一です。
・アップロード、トランスコードの時間はEQ管理画面を使用した場合と同一です。
・トランスコード設定は、標準のトランスコード設定が使用されます。
■WriteAPIのシステム概要
WriteAPIは、通信の最初に認証プログラムから認証キーを取得する必要があります。認証キーは同一プロセス内であれば同じ認証キーを使用し続けることができます。また、取得された認証キーは、最終使用時点から最大3時間同一のものが利用可能です。
また、引数として不正な値が入力されバリデーションエラーが発生した場合、アップロードやメタ情報の編集・削除は実行されません。
【注意事項】
- アップロードキーを利用して操作するAPIは、Businessエディション、Expertエディション、Enterpriseエディション、Unlimited Liveエディションの標準機能です。
- アップロードキーの有効期限は3時間となります。
- メタ情報はAPIサーバーのデータベースに2～4分程度の間隔で更新されます。（サーバーの稼働状況により反映までの時間は異なります。）
- 短時間でのループ処理で負荷をかけるようなタスクはご遠慮ください。
弊社側で高負荷の検知があった場合、ご利用方法についてご相談させていただく場合があります。 - WriteAPIは大量のアクセスに対し制限をかけておりますので、
原則同時1リクエストを推奨します。 - WriteAPIは、Javascriptでのリクエストには対応しておりません。
- プレイヤーAPIは、ライブ配信／疑似ライブ配信のプレイヤーには対応しておりません。
- 本マニュアルに記載されている仕様以外の設定では正しく動作しないことがあります。
- エンドユーザーの操作の度にAPIを実行するなど、リクエスト回数が過度に増えるような実装はご遠慮ください。
- 可能な限り、APIはバックエンドにて実行してください。