ULIZA VMS (Cloud) API 仕様書 (v1.18.1)

本書は ULIZA VMS (Cloud) が提供する API 仕様について記述しています。ULIZA VMS (Cloud) の機能や管理画面の操作方法については ULIZA VMS (Cloud) ユーザーガイド を参照してください。

なお、本書に掲載しているコードサンプル(Request samples)は、具体的な実装例を示すことで開発者を支援することを目的としていますが、掲載しているコードがすべての環境において正常に動作することを保証するものではありません。また、コードサンプル内で使用している関数やライブラリの安全性に関して、弊社は何ら責任を負うものではありません。

注意

本書に記述している API を利用するには、対応するオプション(「ULIZA FLEX II - マルチ WebAPI オプション」など)のご契約が必要となります。詳細については お問い合わせ ください。

CHANGELOG

バージョン 改版日 改版内容
v1.0.0 2019/09/24 初版
v1.1.0 2020/01/23
  1. プレイリストアイテム取得 API を追加
  2. コンテンツ URL 発行 API のレスポンスに description (コンテンツの説明)および tags (タグ情報)を追加
  3. ストリーム取得系 API字幕取得系 API および ポスター画像取得系 API のレスポンスに created_at (登録日時)および updated_at (最終更新日時)を追加
  4. コンテンツ検索 API のクエリパラメータに status (公開状態)、 type (コンテンツ種別)および filters (詳細検索条件)を追加
  5. コンテンツ種別に DVR (DVR コンテンツ)を追加
  6. コンテンツの属性に playlist_item_overrides (プレイリストアイテム設定)を追加
  7. ストリームの属性に encluster_task_id (ULIZA En-Cluster タスク ID)を追加
v1.2.0 2020/06/15
  1. コンテンツフォワードポリシー取得系 API および ストリーミングポリシー取得系 API を追加
  2. 視聴ページ管理系 API および 配信サイト取得系 API を追加
v1.3.0 2020/06/24
  1. 視聴ページの属性に max_simultaneous_viewers (同時視聴可能デバイス数)および access_denial_timeout (再視聴待機時間)を追加
v1.5.0 2020/09/15
  1. 視聴ページの属性に whitelist_referers (アクセス許可参照元ドメイン)および custom_error_responses (カスタムエラーページ設定)を追加
v1.6.0 2020/11/02
  1. コンテンツの属性に chapters (チャプター情報)を追加
  2. コンテンツ URL 発行 API のレスポンスに chapters (チャプター情報)を追加
v1.7.0 2021/01/25
  1. コンテンツの属性に documents (関連資料情報)および presentation_document_id (プレゼンテーション連携資料 ID)を追加
  2. ストリームの属性に audio_track_type (音声タイプ)、 audio_language (音声言語)および audio_label (音声ラベル)を追加
  3. コンテンツ URL 発行 API のレスポンスに documents (関連資料情報)および presentation (プレゼンテーション連携情報)を追加
  4. 視聴ページの属性に revoked_audiences (アクセス拒否ユーザー識別子)および subheader (表示用タイトル)を追加
  5. 視聴ページ全取得 API のクエリパラメータに query (検索キーワード)を追加
v1.7.1 2021/03/02
  1. 視聴ページ URL 無効化 API を追加
v1.8.0 2021/04/30
  1. 配信サイトの属性に max_simultaneous_viewers (同時視聴可能デバイス数)および access_denial_timeout (再視聴待機時間)を追加
v1.9.0 2021/06/22
  1. 視聴ページの属性に sidetalk_room_id (ULIZA Sidetalk ルーム ID)および sidetalk_tag_template (ULIZA Sidetalk 埋め込みタグテンプレート文字列)を追加
v1.10.0 2021/09/07
  1. 配信サイトの属性に authentication.hide_update_password (「パスワードの変更」リンクを隠す)を追加
v1.12.0 2022/03/22
  1. コンテンツあたりの字幕登録可能数を 10 に変更
  2. 配信サイトの属性に user_content_scopes (会員レベルの配信コンテンツ範囲設定)を追加
v1.13.0 2022/05/10
  1. コンテンツ URL 発行 API のレスポンスに streams (ストリーム情報)を追加
v1.14.0 2022/12/01
  1. ストリームの属性に status (状態)を追加
v1.15.0 2023/01/24
  1. 視聴ページおよび配信サイトの属性に status (公開状態)を追加
  2. 視聴ページの属性 template (テンプレート名)に値を追加
v1.15.1 2023/02/20
  1. ストリームの属性 path (動画ファイルパス)の最大文字数を 400 に変更
  2. 配信サイトおよび視聴ページの属性 whitelist_cidrs (アクセス許可 IP アドレス範囲)の最大件数を 1,000 に変更
  3. 配信サイトおよび視聴ページの属性 whitelist_referers (アクセス許可参照元ドメイン)の最大件数を 1,000 に変更
v1.16.0 2023/03/29
  1. コンテンツの属性に playback_count (再生開始数)を追加
v1.17.0 2023/06/06
  1. コンテンツ配信流量取得 API を追加
v1.18.0 2023/07/04
  1. コンテンツの属性 status (公開設定)に LIMITED (期間限定)を追加
  2. コンテンツの属性に publish_start (公開開始日時)および publish_end (公開終了日時)を追加
v1.18.1 2023/08/16
  1. 視聴ページの属性 configurations (視聴ページ設定)に exposed_metadata (コンテンツメタデータ公開設定)を追加
  2. 配信サイトの属性に exposed_metadata.related_contents (関連動画の表示設定)を追加

Authentication

特に断りのない限り、本書に記載されている全ての API に対するリクエストの Authorization ヘッダに下記の形式で有効な API 認証キーを含める必要があります。API 認証キーの取得方法については ULIZA プロダクトアカウントユーザーガイド を参照してください。リクエストに有効な API 認証キーが含まれていない場合は、401 Unauthorized が返却されます。

Authorization: Bearer <api-credential>

Contents

コンテンツ管理系 API について以下に記述します。

コンテンツ検索 API

すべてのコンテンツを取得します。リクエスト送信者が コンテンツの取得 権限を持っていない場合は、403 Forbidden が返却されます。

query Parameters
page
integer >= 1
Default: 1

取得するページ番号

per_page
integer <= 100
Default: 25

1 ページあたりの取得件数

sort
string
Default: "created_at|desc"

ソートする列名および方向(昇順 asc または降順 desc)を | で連結した文字列。使用可能な列名は以下の通りです。

  • name : コンテンツ名
  • created_at : コンテンツ登録日時
type
string

以下のいずれかのコンテンツ種別(コンマ区切りで複数指定可能)。省略した場合はすべて取得します。

  • VOD : VOD コンテンツ
  • LIVE : ライブコンテンツ
  • DVR : DVR コンテンツ
status
string

以下のいずれかの公開設定(コンマ区切りで複数指定可能)。省略した場合はすべて取得します。

  • PUBLIC : 常に公開中
  • PRIVATE : 常に非公開
  • LIMITED : 期間限定
  • PROCESSING : ULIZA En-Cluster により処理中
  • ERROR : ULIZA En-Cluster による処理に失敗
category
string <UUID>

カテゴリ ID(指定した場合はその ID に対応するカテゴリが付与されているコンテンツの一覧を取得します)

label
string <UUID>

ラベル ID(指定した場合はその ID に対応するラベルが付与されているコンテンツの一覧を取得します)

query
string <= 200 characters

検索キーワード(指定した場合はその文字列をコンテンツ名、タイトル、または説明のいずれかに含むコンテンツの一覧を取得します。大文字/小文字は区別されません)

filters
string <JSON>

コンテンツの詳細検索条件を JSON 形式の文字列で指定します(値は URL エンコードする必要があります)。query を指定した場合は無視されます。使用可能なキーは以下の通りで、複数のキーを指定した場合の各条件は AND で結合されます。各キーが指定した値に完全一致するコンテンツのみが返却されます。

  • name : コンテンツ名
  • title : タイトル
  • description : 説明

また、各キーの末尾に以下のいずれかの修飾子を付与することで、完全一致以外の検索条件を使用することができます。ただし、修飾子のみが異なる複数のキーを同時に指定することはできません。

  • :contains : 部分一致
  • :starts_with : 前方一致
  • :ends_with : 後方一致

例えば、コンテンツ名が「news_」から始まり、タイトルに「2019」を含むコンテンツの一覧を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

{
  "name:starts_with": "news_",
  "title:contains": "2019"
}

Responses

Response Schema: application/json
Array of objects

コンテンツ情報

truncated
boolean

全件を表示していない(次のページが存在)

current_page
integer >= 1

現在のページ番号

per_page
integer <= 100

1 ページあたりの取得件数

Request samples

curl \
  -H 'Authorization: Bearer <your-token>' \
  'https://vms-api.p.uliza.jp/v1/contents?page=1&per_page=25&sort=created_at|desc'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "truncated": false,
  • "current_page": 1,
  • "per_page": 25
}

コンテンツ登録 API