カタログAPI

共通処理

リクエストヘッダー

リクエストヘッダーはこちらをご確認ください。

IDもしくは参照IDによるメディアの取得

メディア情報を1件取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
media_id String メディアID 1 media_id, ref_idいずれか必須
ref_id String 参照ID video1
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String メディアID
ref_id String 参照ID (マーチャント内部でユニークである必要がある)
live_event_id String ライブイベントID
name String 名前
description String 説明文
duration Number 尺(milliseconds)
encode_type String エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields Object カスタムフィールドの値、デフォルト値は{}
publish_geo_rule String 公開地域ルール
poster Object ポスター画像
　src String ポスター画像のURL
thumbnaill Object サムネイル画像
　src String サムネイルのURL
seek_preview_config JSON シークプレビュー設定
tags String[] タグの配列
offline_enabled Boolean オフライン再生が可能か
text_tracks Object[] テキストデータの配列
created_at DateString 作成日時
updated_at DateString 更新日時

レスポンスの例

HTTP/1.1 200 OK
{
"merchant_id": "nttsmc",
"id": "7f8d4baf20f244fca34acbe3452886ac",
"ref_id": null,
"live_event_id": "6126a01db6744dca93aa2af575e9ba0c",
"name": "live_event_6126a01db6744dca93aa2af575e9ba0c",
"description": "",
"duration": null,
"encode_type": null,
"custom_fields": {
   "keywords": "live, test",
   "link": "http://test_link"
 },
"publish_geo_rule": [
  "jp"
],
"poster": {
  "src": "/uploads/nttsmc/sample_poster.gif"
},
"thumbnail": {
  "src": "/uploads/nttsmc/sample_thumbnail.jpg"
},
"seek_preview_config": null,
"tags": [],
"offline_enabled": false,
"text_tracks": [
  {
    "kind": "subtitles",
    "lang": "ja",
    "mime_type": "type/vtt",
    "src": "https://s3-ap-northeast-1.amazonaws.com/sample.mp3"
  }
],
"created_at": "2018-02-22T12:03:36.427+09:00",
"updated_at": "2018-02-22T18:44:38.839+09:00"
}
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
403 GEO_RULE アクセス元のIPアドレスは許可されていません
404 MEDIA_NOT_FOUND 該当するメディアが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

メディア一覧の取得

メディア情報の一覧を取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id 任意
job_id String ジョブID id 任意
media_group_id String メディアグループID id 任意
クエリパラメータ
フィールド タイプ 説明 サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String メディアID
ref_id String 参照ID (マーチャント内部でユニークである必要がある)
live_event_id String ライブイベントID
name String 名前
description String 説明文
duration Number 尺(milliseconds)
encode_type String エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields Object カスタムフィールドの値、デフォルト値は{}
publish_geo_rule String 公開地域ルール
poster Object ポスター画像
　src String ポスター画像のURL
thumbnaill Object サムネイル画像
　src String サムネイルのURL
seek_preview_config JSON シークプレビュー設定
tags String[] タグの配列
offline_enabled Boolean オフライン再生が可能か
text_tracks Object[] テキストデータの配列
created_at DateString 作成日時
updated_at DateString 更新日時

レスポンスの例

HTTP/1.1 200 OK
{
  "count": 30,
  "medias":
    [
      {<media1 fields>},
      {<media2 fields>},
      ...
    ]
}
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
404 MEDIA_NOT_FOUND 該当するメディアが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

メディアの編集

メディア情報を編集するAPIです。

HTTPリクエスト
PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

OR

PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
media_id String メディアID 1 media_id, ref_idいずれか必須
ref_id String 参照ID video1
リクエスト
フィールド タイプ 説明 必要性
name String タイトル 任意
description String 説明文 任意
ref_id String 参照ID 任意
publish_status String 公開設定 任意(publish_on,publish_off,before_review,draftから選択)
publish_geo_rule Array 公開対象地域 任意(※)
publish_start_at DateString 公開開始日時 必須
publish_end_at DateString 公開終了日時 任意
thumbnail_image File サムネイル画像ファイル 任意
poster_image File ポスター画像ファイル 任意
thumbnail_image_url String サムネイル画像ファイルURL 任意
poster_image_url String ポスター画像ファイルURL 任意
access_control_ips Jsonb IP制限設定 任意
access_control_hosts Jsonb ホスト制限設定 任意

※ jp,au,gb,ca,fr,nz,in,de,cn,hk,br,us,my,tw,idはそれぞれ日本、オーストラリア、イギリス、カナダ、フランス、ニュージーランド、インド、ドイツ、中華人民共和国、中華人民共和国香港特別行政区、ブラジル、アメリカ、マレーシア、台湾、インドネシアに対応する。

リクエストの例

{
  "name": "sample",
  "publish_status": "publish_on",
  "publish_geo_rule": ["jp","au","de","us"],
  "access_control_ips": {"black_ips":["12.34.56.78","100.100.100.100"]},
  "access_control_hosts": {"black_hosts":["https://sample.jp"]},
  "thumbnail_image_url": "https://sample.ne.jp/sample.jpg"
  ...
}
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String メディアID
ref_id String 参照ID (マーチャント内部でユニークである必要がある)
live_event_id String ライブイベントID
name String 名前
description String 説明文
duration Number 尺(milliseconds)
encode_type String エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields Object カスタムフィールドの値、デフォルト値は{}
publish_geo_rule String 公開地域ルール
poster Object ポスター画像
　src String ポスター画像のURL
thumbnaill Object サムネイル画像
　src String サムネイルのURL
seek_preview_config JSON シークプレビュー設定
tags String[] タグの配列
offline_enabled Boolean オフライン再生が可能か
text_tracks Object[] テキストデータの配列
created_at DateString 作成日時
updated_at DateString 更新日時

メディアの削除

メディアを削除するAPIです。

HTTPリクエスト
DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

OR

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
media_id String メディアID 39u3jmjbaboi12hojnlknn media_id, ref_idいずれか必須
ref_id String 参照ID video1
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String メディアID
ref_id String 参照ID (マーチャント内部でユニークである必要がある)
live_event_id String ライブイベントID
name String 名前
description String 説明文
duration Number 尺(milliseconds)
encode_type String エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields Object カスタムフィールドの値、デフォルト値は{}
publish_geo_rule String 公開地域ルール
poster Object ポスター画像
　src String ポスター画像のURL
thumbnaill Object サムネイル画像
　src String サムネイルのURL
seek_preview_config JSON シークプレビュー設定
tags String[] タグの配列
offline_enabled Boolean オフライン再生が可能か
text_tracks Object[] テキストデータの配列
created_at DateString 作成日時
updated_at DateString 更新日時

レスポンスの例

HTTP/1.1 200 OK
{
"merchant_id": "nttsmc",
"id": "7f8d4baf20f244fca34acbe3452886ac",
"ref_id": null,
"live_event_id": "6126a01db6744dca93aa2af575e9ba0c",
"name": "live_event_6126a01db6744dca93aa2af575e9ba0c",
"description": "",
"duration": null,
"encode_type": null,
"custom_fields": {
   "keywords": "live, test",
   "link": "http://test_link"
 },
"publish_geo_rule": [
  "jp"
],
"poster": {
  "src": "/uploads/nttsmc/sample_poster.gif"
},
"thumbnail": {
  "src": "/uploads/nttsmc/sample_thumbnail.jpg"
},
"seek_preview_config": null,
"tags": [],
"offline_enabled": false,
"text_tracks": [
  {
    "kind": "subtitles",
    "lang": "ja",
    "mime_type": "type/vtt",
    "src": "https://s3-ap-northeast-1.amazonaws.com/sample.mp3"
  }
],
"created_at": "2018-02-22T12:03:36.427+09:00",
"updated_at": "2018-02-22T18:44:38.839+09:00"
}
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
404 MEDIA_GROUP_NOT_FOUND 該当するメディアグループが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

メディアグループ一覧の取得

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_groups
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ サンプル サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String メディアグループID
ref_id String 参照ID
name String 名前
description String 説明文
created_at DateString 作成日時
updated_at DateString 更新日時

レスポンスの例

HTTP/1.1 200 OK
{
  "count": 30,
  "media_groups":
    [
      {<media_group1 fields>},
      {<media_group2 fields>},
      ...
    ]
}
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
500 SERVER_ERROR 予期せぬエラーが発生しました