本マニュアルでは、EQで利用可能なAPIの概要や利用時の留意事項について説明します。
あわせて、APIの仕様を確認できるツールへのリンクも掲載していますので、各APIに関する詳細な仕様については仕様確認ツールをご確認ください。
APIの種類と概要
| API種別 | 分類 | 説明 |
メディアAPI |
ReadAPI |
動画コンテンツや利用状況に関する情報の確認が行えます。 |
WriteAPI |
動画コンテンツやメタ情報の登録/更新/削除が行えます。 | |
ライブAPI |
ReadAPI |
ライブ設定などライブに関する情報の確認が行えます。 |
WriteAPI |
ライブ設定の作成やライブ配信の開始などライブに関する操作が行えます。 | |
| 動画視聴解析API | ReadAPI | 新VAの視聴解析データを取得できます。 |
| プレイヤーAPI | - | EQ専用の動画プレイヤーの制御が行えます。 |
本機能は、外部プログラムからの利用を想定しており、そのプログラムについてはお客様側での開発が必要となります。
プレイヤーAPI以外の仕様については本マニュアル記載の仕様確認ツールをご参照ください。
プレイヤーAPIの仕様に関しては、こちらをご確認ください。
エディション別の利用可否
| API種別 | 分類 | Startup | Business | Expert | Enterprise | Unlimited Live |
メディアAPI |
ReadAPI |
〇 |
〇 |
〇 |
〇 |
|
WriteAPI |
△ |
〇 |
〇 |
〇 |
||
ライブAPI |
ReadAPI |
〇 |
〇 |
〇 |
〇 |
|
WriteAPI |
△ |
〇 |
〇 |
〇 |
||
|
動画視聴解析API (※) |
ReadAPI | 〇 |
〇 |
〇 |
〇 |
|
| プレイヤーAPI | - | 〇 |
〇 |
〇 |
〇 |
|
〇 : 利用可、△: 利用不可(有償オプションにより利用可能)
※:動画視聴解析APIのうち、ユーザー別視聴解析APIのご利用について
・Startupでは、ユーザー別視聴解析APIはご利用いただけません。(※1)
・Businessでは、疑似ライブ配信でのユーザー別視聴解析APIはご利用いただけません。(有償オプションにより利用可能)(※2 )
・Unlimited Liveでは、ライブ配信および疑似ライブ配信でのユーザー別視聴解析APIはご利用いただけません。(※3)
有償オプションをご希望の場合は、弊社営業担当までご連絡ください。
Token情報の確認方法
APIで利用するToken情報は、EQ Management Console(EQ管理画面)の「契約会社情報」画面より、ご確認いただけます。
ただし、 「契約会社情報」は管理者権限ユーザー専用の画面になりますので、ご注意ください。
1. 「各種設定・その他」より、「契約会社情報」をクリックします。
2. 「契約会社情報」画面が表示されますので、「その他」の項目までスクロールするとReadAPIやWriteAPIのToken情報をご確認いただけます。
APIを利用した実装に関する注意事項
- 短時間でのループ処理で負荷をかけるようなタスクはご遠慮ください。
弊社側で高負荷の検知があった場合、ご利用方法についてご相談させていただく場合があります。 - 大量のアクセスに対し制限をかけておりますので、原則同時1リクエストを推奨します。
- アップロードキーを利用するAPIは、Javascriptでのリクエストには対応しておりません。
- エンドユーザーの操作の度にAPIを実行するなど、リクエスト回数が過度に増えるような実装はご遠慮ください。
- 可能な限り、APIはバックエンドにて実行してください。
- 本マニュアルや仕様確認ツールに記載されている仕様以外の設定では正しく動作しないことがあります。
- その他、各APIに関する注意事項は仕様確認ツールをご確認ください。
その他留意事項
- WriteAPIのTokenやアップロードキーを利用するAPIに関しては利用元のIP制限が可能です。
使用可能な通信元をホワイトリスト形式にて制限しますので、利用元のIP制限をご希望の場合は、使用を許可する利用元のIPを弊社担当営業までご連絡ください。 - API経由でアップロードする動画ファイルの推奨仕様は、EQ管理画面からアップロードする場合と同一です。
詳細についてはこちらを参照してください。 - API経由での動画ファイルのアップロード時間およびトランスコード時間は、EQ管理画面からアップロードした場合と同一です。
- メタ情報はAPIサーバーのデータベースに対して、約2~4分間隔で更新されます。
更新内容が反映されるまでの時間は、サーバーの稼働状況によって異なる場合があります。
API一覧(仕様確認ツールへのリンク)
仕様確認ツールご利用時の注意事項
- 本ツールは、各APIの仕様確認および理解を目的として提供しています。
- 各APIのリクエスト内容(パラメータ・ヘッダー・ボディ)のサンプルを確認できるほか、実際に値を入力することで、それに応じたレスポンス例を確認できます。
※実行した際、実データの更新や取得はされません。
|
API種別 (仕様確認ツールへのリンク) |
API名 | 説明 |
メディアAPI |
動画メタ情報取得 |
アップロードされている動画コンテンツのメタ情報を取得できます。 ※カスタムメタデータは、Business/Expert/Enterprise/Unlimited Liveエディションでご利用いただけます。 |
| サムネイル一覧取得 | アップロードされている動画コンテンツに紐づく全サムネイル情報を取得できます。 | |
| 字幕一覧取得 | アップロードされている動画コンテンツに登録されている字幕の情報を取得できます。 | |
| 利用状況取得 | EQにアップロードされた動画コンテンツ等のディスク使用総容量や配信総流量の情報を取得できます。 | |
| アップロードキー取得 | WriteAPIを利用する際に必要なアップロードキーを取得できます。 | |
| 動画アップロード(2GBまで) | 動画をアップロードできます。 アップロード時のメタ情報も設定可能です。 |
|
| チャンクアップロード | 任意のサイズで分割した動画ファイルを順次アップロードできます。 2GBを超える動画ファイルをアップロードしたい場合に使います。 ※契約エディション: Business / Expert / Enterpriseエディションのお客様向け |
|
| メタ情報編集 | アップロードされている動画コンテンツのメタ情報を編集できます。 | |
| サムネイル変更 | アップロードされている動画コンテンツのサムネイルを編集できます。 | |
| ステータス確認 | 動画コンテンツのトランスコードに関する進捗状況を確認できます。 | |
| 動画削除 | アップロードされている動画コンテンツを削除できます。 | |
| 字幕設定 | 動画の字幕情報を新規作成 / 更新できます。 | |
| 字幕削除 | 動画の字幕情報を削除できます。 | |
ライブAPI - 旧EQライブ(v1) |
アップロードキー取得 | 特定のAPIを利用する際に必要となるアップロードキーを取得できます。 |
| ライブプロファイル取得 | ライブプロファイルの設定情報を取得できます。 | |
| ライブプロファイル作成更新 | ライブプロファイルを作成および更新できます。 | |
| ライブイベント名変更 | ライブ配信中にライブイベント名を変更できます。 | |
| ライブプロファイル削除 | ライブプロファイルを削除できます。 | |
| ライブエンコーダー設定取得 | ライブエンコーダー設定情報を取得できます。 | |
| ライブ開始停止 | ライブ配信を開始および停止できます。 | |
| ライブ中イベント情報取得 | ライブ配信中にライブイベント情報を取得できます。 | |
| ライブ同時接続取得 | ライブ本番中の同時接続数を取得できます。 | |
| ライブ同時接続履歴取得 | 過去のライブ開催時の同時接続履歴を取得できます。 | |
| ライブ履歴取得 | 去のライブ開催時の設定情報を取得できます。 | |
| ライブチャット投稿履歴取得 | 過去のライブ開催時のライブチャット履歴を取得できます。 | |
| ライブ分割 | ライブ配信中に録画ファイルを分割できます。 | |
ライブAPI - 新EQライブ(v2) |
アップロードキー取得 | 特定のAPIを利用する際に必要となるアップロードキーを取得できます。 |
| ライブプロファイル取得 | ライブプロファイルの設定情報を取得できます。 | |
| ライブプロファイル作成更新 | ライブプロファイルを作成および更新できます。 | |
| ライブプロファイル削除 | ライブプロファイルを削除できます。 | |
| ライブエンコーダー設定取得 | ライブエンコーダー設定情報を取得できます。 | |
| ライブ有効化 | ライブ配信を有効化できます。 | |
| m3u8取得 | ライブのm3u8を取得できます。 | |
| ライブ開始 | ライブ配信を開始できます。 | |
| ライブ停止 | ライブ配信を停止できます。 | |
| チャット開始 | チャットを開始できます。 | |
| チャット停止 | チャットを停止できます。 | |
| ライブ中イベント情報取得 | ライブ配信中にライブイベント情報を取得できます。 | |
| ライブイベント名変更 | ライブ配信中にライブイベント名を変更できます。 | |
| ライブ分割 | ライブ配信中に録画ファイルを分割できます。 | |
| ライブDVR停止 | ライブDVRを停止できます。 | |
| ライブ履歴取得 | 過去のライブ開催時の設定情報を取得できます。 | |
| ライブ同時接続履歴取得 | 過去のライブ開催時の同時接続履歴を取得できます。 | |
| ライブチャット投稿履歴取得 | 過去のライブ開催時のライブチャット履歴を取得できます。 | |
| 疑似ライブフィラー利用動画一覧取得 | 疑似ライブに利用できるフィラー動画を、一覧で取得できます。 | |
| 疑似ライブ利用動画一覧取得 | 疑似ライブに利用できる動画を、一覧で取得できます。 | |
| 疑似ライブプロファイル取得 | 疑似ライブプロファイルの設定情報を取得できます。 | |
| 疑似ライブプロファイル作成更新 | 疑似ライブプロファイルを作成および更新できます。 | |
| 疑似ライブプロファイル削除 | 疑似ライブプロファイルを削除できます。 | |
| 疑似ライブ停止 | 疑似ライブを強制停止できます。 | |
| 疑似ライブチャット開始 | チャットを開始できます。 | |
| 疑似ライブチャット停止 | チャットを停止できます。 | |
| 疑似ライブ同時接続履歴取得 | 過去の疑似ライブ開催時の同時接続履歴を取得できます。 | |
| 疑似ライブチャット投稿履歴取得 | 過去の疑似ライブ開催時のライブチャット履歴を取得できます。 | |
ライブAPI - 新EQライブ(v3) |
アップロードキー取得 | 特定のAPIを利用する際に必要となるアップロードキーを取得できます。 |
| ライブプロファイル取得 | ライブプロファイルの設定情報を取得できます。 | |
| ライブプロファイル作成更新 | ライブプロファイルを作成および更新できます。 | |
| ライブプロファイル削除 | ライブプロファイルを削除できます。 | |
| ライブエンコーダー設定取得 | ライブエンコーダー設定情報を取得できます。 | |
| ライブ有効化 | ライブ配信を有効化できます。 | |
| m3u8取得 | ライブのm3u8を取得できます。 | |
| ライブ開始 | ライブ配信を開始できます。 | |
| ライブ停止 | ライブ配信を停止できます。 | |
| チャット開始 | チャットを開始できます。 | |
| チャット停止 | チャットを停止できます。 | |
| ライブ中イベント情報取得 | ライブ配信中にライブイベント情報を取得できます。 | |
| ライブイベント名変更 | ライブ配信中にライブイベント名を変更できます。 | |
| ライブ分割 | ライブ配信中に録画ファイルを分割できます。 | |
| ライブDVR停止 | ライブDVRを停止できます。 | |
| ライブ履歴取得 | 過去のライブ開催時の設定情報を取得できます。 | |
| ライブ同時接続履歴取得 | 過去のライブ開催時の同時接続履歴を取得できます。 | |
| ライブチャット投稿履歴取得 | 過去のライブ開催時のライブチャット履歴を取得できます。 | |
| 疑似ライブフィラー利用動画一覧取得 | 疑似ライブに利用できるフィラー動画を、一覧で取得できます。 | |
| 疑似ライブ利用動画一覧取得 | 疑似ライブに利用できる動画を、一覧で取得できます。 | |
| 疑似ライブプロファイル取得 | 疑似ライブプロファイルの設定情報を取得できます。 | |
| 疑似ライブプロファイル作成更新 | 疑似ライブプロファイルを作成および更新できます。 | |
| 疑似ライブプロファイル削除 | 疑似ライブプロファイルを削除できます。 | |
| 疑似ライブ停止 | 疑似ライブを強制停止できます。 | |
| 疑似ライブチャット開始 | チャットを開始できます。 | |
| 疑似ライブチャット停止 | チャットを停止できます。 | |
| 疑似ライブ同時接続履歴取得 | 過去の疑似ライブ開催時の同時接続履歴を取得できます。 | |
| 疑似ライブチャット投稿履歴取得 | 過去の疑似ライブ開催時のライブチャット履歴を取得できます。 | |
動画視聴解析API |
ログイン | APIを利用する際に必要な認証キーを取得できます。 |
| グループ一覧取得 | 他APIのリクエストパラメーターとして利用する、管理グループの情報を取得できます。 | |
| カスタムフィールド一覧取得 | 他APIのリクエストパラメーターとして利用する、カスタムフィールドの情報を取得できます。 | |
| 全体サマリー | オンデマンド動画全体のサマリーを取得できます。 | |
| 全体コンテンツリスト | オンデマンド動画全体のコンテンツリストから視聴状況タブの値を取得できます。 | |
| 全体コンテンツクリックリスト | オンデマンド動画全体のコンテンツリストからクリック数タブの値を取得できます。 | |
| 各動画の掲載ページURL一覧 | オンデマンド動画毎の掲載ページURL一覧を取得できます。 | |
| 動画別の日別・時間帯別リスト | 動画別・日時別のリストを取得できます。 | |
| キーリスト取得 | ユーザ別視聴解析内のキーリストを取得できます。 | |
| オンデマンド動画管理画面データ一覧取得 | 管理画面のユーザー別視聴解析>オンデマンド動画に表示されている値を取得できます。 | |
| ライブ管理画面データ一覧取得 | 管理画面のユーザー別視聴解析>ライブに表示されている値を取得できます。 | |
| 疑似ライブ管理画面データ一覧取得 | 管理画面のユーザー別視聴解析>疑似ライブに表示されている値を取得できます。 | |
| オンデマンド動画データ一覧取得 |
※旧VAでCSVファイル取得機能を利用していたお客様向けのAPIです。 ユーザー別視聴解析で取得したオンデマンド動画に関する値を取得できます。 旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。 |
|
| ライブデータデータ一覧取得 |
※旧VAでCSVファイル取得機能を利用していたお客様向けのAPIです。 ユーザー別視聴解析で取得したライブに関する値を取得できます。 旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。 |
|
| 疑似ライブデータデータ一覧取得 |
※旧VAでCSVファイル取得機能を利用していたお客様向けのAPIです。 ユーザー別視聴解析で取得した疑似ライブに関する値を取得できます。 旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。 |