カタログ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
リクエストヘッダー

このAPIはマーチャント単位で認証の有無を設定することができます。
認証を必要とする場合、リクエストヘッダーに認証情報を設定してください。

フィールドタイプ説明
AuthorizationStringAuthorization: Bearer access_token
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
media_idStringメディアID1media_id, ref_idいずれか必須
ref_idString参照IDvideo1
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringメディアID
ref_idString参照ID (マーチャント内部でユニークである必要がある)
live_event_idStringライブイベントID
nameString名前
descriptionString説明文
durationNumber尺(milliseconds)
encode_typeStringエンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fieldsObjectカスタムフィールドの値、デフォルト値は{}
publish_geo_ruleString公開地域ルール
posterObjectポスター画像
 srcStringポスター画像のURL
thumbnaillObjectサムネイル画像
 srcStringサムネイルのURL
seek_preview_configJSONシークプレビュー設定
tagsString[]タグの配列
offline_enabledBooleanオフライン再生が可能か
text_tracksObject[]テキストデータの配列
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

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"
}
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
403GEO_RULEアクセス元のIPアドレスは許可されていません
404MEDIA_NOT_FOUND該当するメディアが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

メディア一覧の取得

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

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

このAPIはマーチャント単位で認証の有無を設定することができます。
認証を必要とする場合、リクエストヘッダーに認証情報を設定してください。

フィールドタイプ説明
AuthorizationStringAuthorization: Bearer access_token
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDid任意
job_idStringジョブIDid任意
media_group_idStringメディアグループIDid任意
クエリパラメータ
フィールドタイプ説明サンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringメディアID
ref_idString参照ID (マーチャント内部でユニークである必要がある)
live_event_idStringライブイベントID
nameString名前
descriptionString説明文
durationNumber尺(milliseconds)
encode_typeStringエンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fieldsObjectカスタムフィールドの値、デフォルト値は{}
publish_geo_ruleString公開地域ルール
posterObjectポスター画像
 srcStringポスター画像のURL
thumbnaillObjectサムネイル画像
 srcStringサムネイルのURL
seek_preview_configJSONシークプレビュー設定
tagsString[]タグの配列
offline_enabledBooleanオフライン再生が可能か
text_tracksObject[]テキストデータの配列
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

HTTP/1.1 200 OK
{
  "count": 30,
  "medias":
    [
      {<media1 fields>},
      {<media2 fields>},
      ...
    ]
}
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
404MEDIA_NOT_FOUND該当するメディアが存在しません
500SERVER_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_idStringマーチャントIDnttsmc必須
media_idStringメディアID1media_id, ref_idいずれか必須
ref_idString参照IDvideo1
リクエスト
フィールドタイプ説明必要性
nameStringタイトル任意
descriptionString説明文任意
ref_idString参照ID任意
publish_statusString公開設定任意(publish_on,publish_off,before_review,draftから選択)
publish_geo_ruleArray公開対象地域任意(※)
publish_start_atDateString公開開始日時必須
publish_end_atDateString公開終了日時任意
thumbnail_imageFileサムネイル画像ファイル任意
poster_imageFileポスター画像ファイル任意
thumbnail_image_urlStringサムネイル画像ファイルURL任意
poster_image_urlStringポスター画像ファイルURL任意
access_control_ipsJsonbIP制限設定任意
access_control_hostsJsonbホスト制限設定任意

※ 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_idStringマーチャントID
idStringメディアID
ref_idString参照ID (マーチャント内部でユニークである必要がある)
live_event_idStringライブイベントID
nameString名前
descriptionString説明文
durationNumber尺(milliseconds)
encode_typeStringエンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fieldsObjectカスタムフィールドの値、デフォルト値は{}
publish_geo_ruleString公開地域ルール
posterObjectポスター画像
 srcStringポスター画像のURL
thumbnaillObjectサムネイル画像
 srcStringサムネイルのURL
seek_preview_configJSONシークプレビュー設定
tagsString[]タグの配列
offline_enabledBooleanオフライン再生が可能か
text_tracksObject[]テキストデータの配列
created_atDateString作成日時
updated_atDateString更新日時

メディアの削除

メディアを削除する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
リクエストヘッダー

リクエストヘッダーで下記を指定します。

フィールドタイプ説明
AuthorizationStringAuthorization: Bearer access_token
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
media_idStringメディアID39u3jmjbaboi12hojnlknnmedia_id, ref_idいずれか必須
ref_idString参照IDvideo1
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringメディアID
ref_idString参照ID (マーチャント内部でユニークである必要がある)
live_event_idStringライブイベントID
nameString名前
descriptionString説明文
durationNumber尺(milliseconds)
encode_typeStringエンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fieldsObjectカスタムフィールドの値、デフォルト値は{}
publish_geo_ruleString公開地域ルール
posterObjectポスター画像
 srcStringポスター画像のURL
thumbnaillObjectサムネイル画像
 srcStringサムネイルのURL
seek_preview_configJSONシークプレビュー設定
tagsString[]タグの配列
offline_enabledBooleanオフライン再生が可能か
text_tracksObject[]テキストデータの配列
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

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"
}
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
404MEDIA_GROUP_NOT_FOUND該当するメディアグループが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_groups
リクエストヘッダー

このAPIはマーチャント単位で認証の有無を設定することができます。
認証を必要とする場合、リクエストヘッダーに認証情報を設定してください。

フィールドタイプ説明
AuthorizationStringAuthorization: Bearer access_token
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプサンプルサンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringメディアグループID
ref_idString参照ID
nameString名前
descriptionString説明文
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

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