API利用概要 / 仕様確認ツール

本マニュアルでは、EQで利用可能なAPIの概要や利用時の留意事項について説明します。
あわせて、APIの仕様を確認できるツールへのリンクも掲載していますので、各APIに関する詳細な仕様については仕様確認ツールをご確認ください。

APIの種類と概要

本機能は、外部プログラムからの利用を想定しており、そのプログラムについてはお客様側での開発が必要となります。
プレイヤーAPI以外の仕様については本マニュアル記載の仕様確認ツールをご参照ください。

プレイヤー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のリクエスト内容（パラメータ・ヘッダー・ボディ）のサンプルを確認できるほか、実際に値を入力することで、それに応じたレスポンス例を確認できます。
  ※実行した際、実データの更新や取得はされません。