1. イントロダクション

ビデオプラットフォームサービスAPIのドキュメントへようこそ。

2. 共通仕様

2.1. レート制限

APIごとに実行できるリクエスト回数はマーチャント単位で異なります。
営業担当までお問い合わせください。
デフォルト設定は下記の通りです。

プラン	APIリクエスト
デフォルト	50/分

2.2. リクエストヘッダー

特に記載のない限りリクエストヘッダーで下記を指定する必要があります。

フィールド	タイプ	説明
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

2.3. 認証

API一部はアクセスするために、アクセストークンを設定する必要があります。
アカウントごとに認証APIリクエストをすることで、一定期間有効なアクセストークンが発行されます。

2.3.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/auth-token/

2.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル
merchant_id	String	マーチャントID	nttsmc

リクエストボディの例

{
  "mail_address": "smartstream@nttsmc.jp",
  "password": "nttsmc12345"
}

2.3.2. リクエストボディ

フィールド	タイプ	説明
mail_address	String	メールアドレス
password	String	パスワード

レスポンスの例

{
  "token": "20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lg12ijij234i2hikjbkjbhbkjnlai4ugq-",
  "expiration": "2017-10-01T00:00:00.000Z"
}

2.3.3. レスポンス

フィールド	タイプ	サンプル
token	String	アクセストークン
expiration	DateString	アクセストークンの有効期間

2.3.4. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

3. プレイバックAPI

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

メディアの情報をIDもしくは参照IDで取得するAPIです。

3.1.1. HTTPリクエスト

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

OR

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id

3.1.2. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

3.1.3. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
media_id	String	メディアID	*****	media_id, ref_idのいずれか必須
merchant_id	String	マーチャントID	nttsmc	必須
ec_url	UrlString	エンタイトルメントチェックURL	https://...	任意
ref_id	String	参照ID	video1
user_id	String	ユーザーID	1	任意

3.1.4. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	メディアID
ref_id	String	参照ID (マーチャント内部でユニークである必要がある)
name	String	名前
description	Text	説明文
duration	Number	尺(milliseconds)
encode_type	String	エンコードタイプ (ファイル or ライブ or スケジュールライブ
publish_status	String	公開設定
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	オフライン再生が可能か
sources	Object[]	動画ソースの配列
text_tracks	Object[]	テキストデータの配列
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

{
"id": "40459b7e6e414652828f98af788f3abc",
"name": "BigBuckBunny",
"ref_id": null,
"description": null,
"thumbnail": {
   "src": "https://images.smartstream.jp/nttsmc/12345667890/1234567890.jpg"
},
"poster": {
   "src": "https://images.smartstream.jp/nttsmc/12345667890/9999999999.jpg"
},
"tags": [],
"encode_type": "",
"publish_status": "",
"custom_fields": {},
"merchant_id": "nttsmc",
"publish_geo_rule": null,
"sources": [
  {
    "type": "application/vnd.apple.mpegurl",
    "src": "https://ovp-vod.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/11111111/playlist.m3u8",
    "label": "35f91a9919164562b3dbb109fc27def4",
    "key_systems": {
      "com.apple.fps.1_0": {
        "key_request_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/fairplay-license/?token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g",
        "certificate_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/fairplay-license/cert/?specConform=true&token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
      }
    },
    "id": "791f9297e1da4ada8afcec2bea0c3a31"
  },
  {
    "type": "application/dash+xml",
    "src": "https://ovp-vod.smartstream.jp/nttsmc/1/123567890/manifest.mpd",
    "label": "b5c8614dd18249b5830e3238a28ed71e",
    "key_systems": {
      "com.widevine.alpha": {
        "license_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/cenc/?specConform=true&token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
      },
      "com.microsoft.playready": {
        "license_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/RightsManager.asmx?token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
      }
    },
    "id": "bca76a9f43214294b5d6db7e5acce5c2"
  }
],
"duration": 3600000,
"text_tracks": [
  {
    "mime_type": "text/vtt",
    "default": false,
    "src": "https://assets.smartstream.jp/nttsmc/1234567890.vtt?mediaId=40459b7e6e414652828f98af788f3abc",
    "asset_id": "1111111111"
    "label": "ES",
    "id": "f696dc837e9a43f6b12e0f039bfb2f89",
    "kind": "captions",
    "lang": "es"
  }
],
"seek_preview_config": null,
"created_at": "2017-10-01T00:00:00.000Z",
"updated_at": "2017-10-01T00:00:00.000Z",
"offline_enabled": false
}

3.1.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4. インジェストAPI(ビデオ)

4.1. 共通処理

4.1.1. リクエストヘッダー

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

リクエストヘッダー	タイプ	説明
Authorization	String	Authorization: Bearer access_token

4.2. リモートアセットのインジェスト

http(s)://でアクセスすることができる素材を指定してビデオを作成することができます。

4.2.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

4.2.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

4.2.3. リクエストボディ

フィールド	タイプ	説明	必要性
source_url	String	ビデオソースのURL(http(s)://)	必須
job_profile_id	Integer	ジョブプロファイル ID	必須

4.2.4. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
merchant_id	String	マーチャントID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.2.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	JOB_PROFILE_NOT_FOUND	該当するジョブプロファイルが存在しません
404	STORAGE_NOT_FOUND	該当するストレージが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.3. ローカルファイルのインジェスト

curlコマンドのFオプションで指定されたローカルファイルをアップロードしてエンコードすることができます。

4.3.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

4.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

4.3.3. リクエストヘッダー

フィールド	タイプ	説明	必要性
Profile-Id	String	ジョブプロファイルID	必須ではない(*)

*:省略した場合はデフォルトプロファイルを使用してエンコードが行われます。

4.3.4. リクエストボディ

フィールド	タイプ	説明	必要性
source_file	Hash	ビデオソースファイル名	必須

リクエストの例

curl -H 'X-Streaks-Api-Key:<api-key>' 
     -H 'Authorization:Bearer <auth-token>' 
     -H 'Profile-Id: <profile_id>' 
     -XPOST https://ovp-s-api.smartstream.ne.jp/v1/merchants/smartstream/jobs 
     -F "source_file=@smartstream.mp4"

4.3.5. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
merchant_id	String	マーチャントID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.3.6. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	JOB_PROFILE_NOT_FOUND	該当するジョブプロファイルが存在しません
404	STORAGE_NOT_FOUND	該当するストレージが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.4. IDもしくは参照IDによるジョブ情報の取得

ジョブ情報をIDまたは参照IDを指定して1件取得するAPIです。

4.4.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/:job_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/ref:ref_id

4.4.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
job_id	String	ジョブID	*****	job_id, ref_idのいずれか必須
ref_id	String	参照ID	job_1

4.4.3. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
merchant_id	String	マーチャントID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.4.4 エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	JOB_NOT_FOUND	該当するジョブが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.5. ジョブ情報一覧の取得

ジョブ情報を一括取得するAPIです。

4.5.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

4.5.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

4.5.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

4.5.4. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
merchant_id	String	マーチャントID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.5.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

4.6. IDもしくは参照IDによるジョブプロファイル情報の取得

プロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

4.6.1 HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/:job_profile_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/ref:ref_id

4.6.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
job_profile_id	String	ジョブプロファイルID	*****	job_profile_id, ref_idのいずれか必須
ref_id	String	参照ID	job_profile_1

4.6.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ジョブプロファイルID
ref_id	String	参照ID
name	String	ジョブプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

4.6.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	JOB_PROFILE_NOT_FOUND	該当するジョブプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.7. ジョブプロファイル情報一覧の取得

プロファイル情報を一括取得するAPIです。

4.7.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles

4.7.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

4.7.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

4.7.4. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ジョブプロファイルID
ref_id	String	参照ID
name	String	ジョブプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "job_profiles":
    [
      {<job_profile1 fields>},
      {<job_profile2 fields>},
      ...
    ]
}

4.7.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5. ライブAPI

5.1. 共通処理

5.1.1. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

5.2. IDもしくは参照IDによるライブイベントの取得

ライブイベント情報をIDまたは参照IDを指定して1件取得するAPIです。

5.2.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id

5.2.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	id

5.2.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	クリップフラグ
encode_status	String	エンコード状態
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
preview	Object	ライブプレビュー画像
src	String	ライブプレビュー画像のURL
created_at	String	作成日時
updated_at	String	更新日時
preview	Object	ライブプレビュー画像
src	String	ポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "live_encode_start_at":null,
    "live_encode_end_at":null,
    "created_at":"2018-03-14T14:42:04.632+09:00",
    "updated_at":"2018-03-14T16:39:04.428+09:00",
    "preview":
    {
      "src":"https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.2.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.3. ライブイベントの一覧取得

ライブイベント情報を一括で取得するAPIです。

5.3.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events

5.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

5.3.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.3.4. レスポンス

フィールド	タイプ	説明
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
merchant_id	String	契約者ID
description	String	説明
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	クリップフラグ
encode_status	String	エンコード状態
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
preview	Object	ライブプレビュー画像
src	String	ライブプレビュー画像のURL
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "live_events":
    [
      {<live_event1 fields>},
      {<live_event2 fields>},
      ...
    ]
}

5.3.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.4. ライブイベントの作成

ライブイベントを作成するAPIです。

5.4.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events

5.4.2. URLパラメータ

フィールド	タイプ	説明	サンプル
merchant_id	String	マーチャントID	nttsmc

5.4.3. リクエスト

フィールド	タイプ	説明	必要性
name	String	ライブイベント名	必須
description	String	説明	任意
ref_id	String	参照ID	任意
source_type	String	入力プロトコルタイプ	任意(rtmp, rtp, udpから選択可。default値はrtmp)
enable_ad_insertion_flag	Boolean	広告挿入フラグ	任意
live_event_profile_id	String	ライブイベントプロファイルID	必須
enable_live_to_file_flag	Boolean	クリップフラグ	任意
live_encode_start_at	String	エンコード開始日時	任意
live_encode_end_at	String	エンコード終了日時	任意

5.4.4. レスポンス

フィールド	タイプ	説明
merchant_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	ライブイベントの参照ID
name	String	ライブイベント名
description	String	説明
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
media_id	String	メディアID
enable_live_to_file_flag	Boolean	クリップフラグ
encode_status	String	エンコード状態
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
created_at	String	作成日時
updated_at	String	更新日時
preview	Object	ライブプレビュー画像
src	String	ポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "live_encode_start_at":null,
    "live_encode_end_at":null,
    "created_at":"2018-03-14T14:42:04.632+09:00",
    "updated_at":"2018-03-14T16:39:04.428+09:00",
    "preview":
    {
      "src":"https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.4.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
400	FAILED_TO_SAVE	保存処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.5. ライブイベントの開始

ライブイベントを開始するAPIです。

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/start

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/start

5.5.1. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	ref_id

5.5.2. レスポンス

フィールド	タイプ	説明
merchant_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	ライブイベントの参照ID
name	String	ライブイベント名
description	String	説明
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
media_id	String	メディアID
enable_live_to_file_flag	Boolean	クリップフラグ
encode_status	String	エンコード状態
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
created_at	String	作成日時
updated_at	String	更新日時
preview	Object	ライブプレビュー画像
src	String	ポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.5.3. エラーコード

ステータスコード	コード	メッセージ
400	FAILED_TO_SAVE	保存処理に失敗しました
400	FAILED_TO_START	開始処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当のライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.6. ライブイベントの停止

ライブイベントを停止するAPIです。ライブを再開すためには停止後リセットする必要があります。

5.6.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/stop

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/stop

5.6.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	ref_id

5.6.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	ライブイベントの参照ID
name	String	ライブイベント名
description	String	説明
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
media_id	String	メディアID
enable_live_to_file_flag	Boolean	クリップフラグ
encode_status	String	エンコード状態
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
created_at	String	作成日時
updated_at	String	更新日時
preview	Object	ライブプレビュー画像
src	String	ポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.6.4. エラーコード

ステータスコード	コード	メッセージ
400	FAILED_TO_STOP	停止処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当のライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.7. ライブイベントのリセット

ライブイベントをリセットするAPIです。

5.7.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/reset

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/reset

5.7.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	id

5.7.3. レスポンス

HTTP/1.1 200 OK

5.7.4. エラーコード

ステータスコード	コード	メッセージ
400	FAILED_TO_RESET	リセット処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.8. ライブイベントのキャンセル

ライブイベントをキャンセルするAPIです。

5.8.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/cancel

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/cancel

5.8.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	id

5.8.3. レスポンス

HTTP/1.1 200 OK

5.8.4. エラーコード

ステータスコード	コード	メッセージ
400	FAILED_TO_CANCEL	キャンセル処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.9. ライブイベントの更新

ライブイベント情報を更新するAPIです。

5.9.1. HTTPリクエスト

PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id

5.9.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	id

5.9.3. リクエストボディ

フィールド	タイプ	説明
name	String	ライブイベント名
description	String	説明
ref_id	String	参照ID
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
enable_live_to_file_flag	Boolean	クリップフラグ
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時

5.9.4. レスポンス

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.9.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
400	FAILED_TO_UPDATE	更新処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.10. ライブイベントの削除

ライブイベントを削除するAPIです。ライブ配信中に削除をする場合、停止されてから削除されます。

5.10.1. HTTPリクエスト

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id

5.10.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	live_event_id, ref_idいずれか必須
ref_id	String	参照ID	id

5.10.3. レスポンス

HTTP/1.1 200 OK

{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.10.4. エラーコード

ステータスコード	コード	メッセージ
400	FAILED_TO_DELETE	削除処理に失敗しました
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.11. IDもしくは参照IDによるライブイベントプロファイルの取得

ライブイベントプロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

5.11.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles/:live_event_profile_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles/ref:ref_id

5.11.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_profile_id	String	ライブイベントプロファイルID	id	live_event_profile_id, ref_idいずれか必須
ref_id	String	参照ID	ref_id

5.11.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ライブイベントプロファイルID
ref_id	String	ライブイベントプロファイルの参照ID
name	String	ライブイベントプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

5.11.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.12. ライブイベントプロファイルの一覧取得

ライブイベントプロファイルを一括で取得するAPIです。

5.12.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles

5.12.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

5.12.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.12.4. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ライブイベントプロファイルID
ref_id	String	参照ID
name	String	ライブイベントプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "profiles":
    [
      {<profile1 fields>},
      {<profile2 fields>},
      ...
    ]
}

5.12.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

6. カタログAPI

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

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

6.1.1. HTTPリクエスト

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

OR

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id

6.1.2. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

6.1.3. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
media_id	String	メディアID	1	media_id, ref_idいずれか必須
ref_id	String	参照ID	video1

6.1.4. レスポンス

フィールド	タイプ	説明
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"
}

6.1.5. エラーコード

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

6.2. メディア一覧の取得

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

6.2.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/

6.2.2. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

6.2.3. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
live_event_id	String	ライブイベントID	id	任意
job_id	String	ジョブID	id	任意
media_group_id	String	メディアグループID	id	任意

6.2.4. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

6.2.5. レスポンス

フィールド	タイプ	説明
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>},
      ...
    ]
}

6.2.6. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

6.3. メディアの編集

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

6.3.1. 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

6.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
media_id	String	メディアID	1	media_id, ref_idいずれか必須
ref_id	String	参照ID	video1

6.3.3. リクエスト

フィールド	タイプ	説明	必要性
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"
  ...
}

6.3.4. レスポンス

フィールド	タイプ	説明
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	更新日時

6.4. メディアの削除

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

6.4.1. 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

6.4.2. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

6.4.3. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
media_id	String	メディアID	39u3jmjbaboi12hojnlknn	media_id, ref_idいずれか必須
ref_id	String	参照ID	video1

6.4.4. レスポンス

フィールド	タイプ	説明
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"
}

6.4.5. エラーコード

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

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

6.5.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_groups

6.5.2. リクエストヘッダー

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

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token

6.5.3. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

6.5.4. クエリパラメータ

フィールド	タイプ	サンプル	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

6.5.5. レスポンス

フィールド	タイプ	説明
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>},
      ...
    ]
}

6.5.6. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

7. 分析API

7.1. 分析画面で閲覧可能な情報を取得するためのAPI

7.1.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/aggregations?<query>

7.1.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

7.1.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
media_id	String	メディアID	*****
target	String	取得情報の種類	下表参照
interval	String	取得期間の単位	下表参照
group	String	取得情報の分類方法	下表参照
from	String	取得開始日時	20180101000000
to	String	取得終了日時	20181231235959

7.1.4. 取得方法の種類(target)について

フィールド	説明
play_count	再生数(回)
device_count	端末数
session_count	セッション数
play_time	再生時間(秒)
average_play_time	平均再生時間(秒)
player_count	プレイヤー表示数(回)
key_delivery_count	DRMキー取得数(回)

targetを省略した場合はデフォルト値のplay_countが適用される。

7.1.5. 取得期間の単位(interval)について

フィールド	説明
month	月毎
day	日毎
hour	時間毎
minute	分毎

intervalを省略した場合はデフォルト値のdayが適用される。 DRMキー取得数のみ、時間毎、分毎の取得ができない。

7.1.6. 取得情報の分類方法(group)について

フィールド	説明
all	統合
country	国別
player	プレイヤー別
site	サイト別
device	デバイス別
os	OS別
percentage	割合

groupを省略した場合はallが適用される。 DRMキー取得数のみ、all以外の取得ができない。

7.1.7. レスポンス

フィールド	説明
date	取得対象日時
group	取得情報の分類

レスポンスの例

HTTP/1.1 200 OK

{
  [
    {
      "date": "2018/12/01 14:34",
      "all": 10
    },
    {
      "date": "2018/12/01 14:35",
      "all": 12
    },
    ...
  ]
}

8. プレイヤー関連API

8.1. IDもしくは参照IDによるプレイヤーの取得

プレイヤー情報をIDまたは参照IDを指定して1件取得するAPIです。

8.1.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/players/:player_id

8.1.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
player_id	String	プレイヤーID	id	player_id, ref_idいずれか必須
ref_id	String	参照ID	id

8.1.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ID
ref_id	String	参照ID
name	String	プレイヤー名
enable_start_over_flag	Boolean	頭出しフラグ
enable_share_flag	String	シェアフラグ
enable_embed_code_flag	String	埋め込みコードフラグ
twitter_condition	String	twitterシェアフラグ
facebook_condition	Object	facebookシェアフラグ

レスポンスの例

HTTP/1.1 200 OK

{
    "merchant_id":"logiclogic",
    "id":"ab817b0d64d648e580f74bee47d7959f",
    "ref_id":null,
    "name":"テストプレイヤー",
    "enable_start_over_flag":false,
    "enable_share_flag":false,
    "enable_embed_code_flag":false,
    "twitter_condition":null,
    "facebook_condition":null
}

8.2. プレイヤーの一覧取得

プレイヤー情報を一括で取得するAPIです。

8.2.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/players

8.2.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

8.2.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
id	String	ID
ref_id	String	参照ID
name	String	プレイヤー名
enable_start_over_flag	Boolean	頭出しフラグ
enable_share_flag	Boolean	シェアフラグ
enable_embed_code_flag	Boolean	埋め込みコードフラグ
twitter_condition	Boolean	twitterシェアフラグ
facebook_condition	Boolean	facebookシェアフラグ

レスポンスの例

HTTP/1.1 200 OK

{
  "count": ,
  "players":
    [
      {<player1 fields>},
      {<player2 fields>},
      ...
    ]
}

8.3. プレイヤーの削除

プレイヤーを削除するAPIです。削除するプレイヤーをベースに作成されている配信webプレイヤーも共に削除されます。

8.3.1. HTTPリクエスト

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/players/:player_id

OR

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/players/ref:ref_id

8.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
player_id	String	プレイヤーID	id	player_id, ref_idいずれか必須
ref_id	String	参照ID	id

8.3.3. レスポンス

HTTP/1.1 200 OK

{
    "merchant_id":"logiclogic",
    "id":"ab817b0d64d648e580f74bee47d7959f",
    "ref_id":null,
    "name":"テストプレイヤー",
    "enable_start_over_flag":false,
    "enable_share_flag":false,
    "enable_embed_code_flag":false,
    "twitter_condition":null,
    "facebook_condition":null
}

8.4. IDもしくは参照IDによる配信webプレイヤーの取得

配信webプレイヤー情報をIDまたは参照IDを指定して1件取得するAPIです。

8.4.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players/:media_player_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players/ref:ref_id

8.4.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
media_player_id	String	配信webプレイヤーID	id	media_player_id, ref_idいずれか必須
ref_id	String	参照ID	id

8.4.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
index_page_url	String	配信webプレイヤーURL
id	String	ID
ref_id	String	参照ID
name	String	配信webプレイヤー名
description	String	説明
player_id	Stging	プレイヤーID
media	Object	メディア情報
media_group	Object	メディアグループ情報
width	Integer	プレイヤー幅
height	Integer	プレイヤー高さ
iframe_embed_code	String	iframeタグ
embed_code	String	ビデオタグ
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "merchant_id": "nttsmc",
  "index_page_url": "https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529",
  "id": "1d76a2cf8513417194ffb551104280d3",
  "ref_id": null,
  "name": "サンプル",
  "description": null,
  "player_id": "87646c7790d648d6a777a4b35f2c82ab",
  "media": {
    [media fields]
  },
  "media_group": null,
  "width": 960,
  "height": 540,
  "iframe_embed_code": "<iframe src=\"https://ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529\" width=\"960\"  height=\"540\" frameborder=\"0\" allowfullscreen></iframe>",
  "embed_code": "<script src=\"https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/streaks-player.js\"></script>\n<video id=\"video1\" class=\"logica-player lgcp-default-skins\" data-media-player-id=\"1d76a2cf8513417194ffb551104280d3\" width=\"960\" height=\"540\"/>\n<script>streaksplayer(\"video1\").loadVideo();</script>",
  "created_at": "2018-11-01T19:59:45.278+09:00",
  "updated_at": "2018-11-01T19:59:45.278+09:00"
}

8.5. 配信webプレイヤーの一覧取得

配信webプレイヤー情報を一括で取得するAPIです。クエリパラメータにメディアIDまたはメディア参照IDを指定すると、指定メディアをベースに作成された配信webプレイヤーの一覧が取得可能です。

8.5.1. HTTPリクエスト

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players

8.5.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須

8.5.3. クエリパラメータ

フィールド	タイプ	説明	サンプル	必要性
media_id	String	メディアID	ID	任意
ref_id	String	参照ID	id	任意

8.5.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
index_page_url	String	配信webプレイヤーURL
id	String	ID
ref_id	String	参照ID
name	String	配信webプレイヤー名
description	String	説明
player_id	Stging	プレイヤーID
media	Object	メディア情報
media_group	Object	メディアグループ情報
width	Integer	プレイヤー幅
height	Integer	プレイヤー高さ
iframe_embed_code	String	iframeタグ
embed_code	String	ビデオタグ
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 10,
  "media_players":
    [
      {<media_player1 fields>},
      {<media_player2 fields>},
      ...
    ]
}

8.6. 配信webプレイヤーの作成

配信webプレイヤーを作成するAPIです。

8.6.1. HTTPリクエスト

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players

8.6.2. リクエスト

フィールド	タイプ	説明	サンプル	必要性
player_id	String	プレイヤーID	id	必須
media_id	String	メディアID	id	必須
width	Integer	プレイヤー幅	960	必須
height	Integer	プレイヤー高さ	540	必須

8.6.3. レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
index_page_url	String	配信webプレイヤーURL
id	String	配信webプレイヤーID
ref_id	String	参照ID
name	String	配信webプレイヤー名
description	String	説明文
player_id	String	プレイヤーID
media	String	メディア情報
media_group	String	メディアグループ情報
width	Integer	プレイヤー幅
height	Integer	プレイヤー高さ
iframe_embed_code	String	iframeタグ
embed_code	String	ビデオタグ
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "merchant_id": "nttsmc",
  "index_page_url": "https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529",
  "id": "1d76a2cf8513417194ffb551104280d3",
  "ref_id": null,
  "name": "サンプル",
  "description": null,
  "player_id": "87646c7790d648d6a777a4b35f2c82ab",
  "media": {
    [media fields]
  },
  "media_group": null,
  "width": 960,
  "height": 540,
  "iframe_embed_code": "<iframe src=\"https://ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529\" width=\"960\"  height=\"540\" frameborder=\"0\" allowfullscreen></iframe>",
  "embed_code": "<script src=\"https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/streaks-player.js\"></script>\n<video id=\"video1\" class=\"logica-player lgcp-default-skins\" data-media-player-id=\"1d76a2cf8513417194ffb551104280d3\" width=\"960\" height=\"540\"/>\n<script>streaksplayer(\"video1\").loadVideo();</script>",
  "created_at": "2018-11-01T19:59:45.278+09:00",
  "updated_at": "2018-11-01T19:59:45.278+09:00"
}

8.6.4. エラーコード

ステータスコード	コード	メッセージ
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
404	PLAYER_NOT_FOUND	該当するプレイヤーが存在しません

8.7. 配信webプレイヤーの削除

配信webプレイヤーを削除するAPIです。

8.7.1. HTTPリクエスト

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players/:media_player_id

OR

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/media_players/ref:ref_id

8.7.2. URLパラメータ

フィールド	タイプ	説明	サンプル	必要性
merchant_id	String	マーチャントID	nttsmc	必須
media_player_id	String	配信webプレイヤーID	id	media_player_id, ref_idいずれか必須
ref_id	String	参照ID	id

8.7.3. レスポンス

レスポンスの例

HTTP/1.1 200 OK

{
  "merchant_id": "nttsmc",
  "index_page_url": "https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529",
  "id": "1d76a2cf8513417194ffb551104280d3",
  "ref_id": null,
  "name": "サンプル",
  "description": null,
  "player_id": "87646c7790d648d6a777a4b35f2c82ab",
  "media": {
    [media fields]
  },
  "media_group": null,
  "width": 960,
  "height": 540,
  "iframe_embed_code": "<iframe src=\"https://ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/index.html?mp=1d76a2cf8513417194ffb551104280d3&ts=1537500529\" width=\"960\"  height=\"540\" frameborder=\"0\" allowfullscreen></iframe>",
  "embed_code": "<script src=\"https://stg-ovp-player.smartstream.ne.jp/nttsmc/output/player/87646c7790d648d6a777a4b35f2c82ab/streaks-player.js\"></script>\n<video id=\"video1\" class=\"logica-player lgcp-default-skins\" data-media-player-id=\"1d76a2cf8513417194ffb551104280d3\" width=\"960\" height=\"540\"/>\n<script>streaksplayer(\"video1\").loadVideo();</script>",
  "created_at": "2018-11-01T19:59:45.278+09:00",
  "updated_at": "2018-11-01T19:59:45.278+09:00"
}

9. DRM関連処理

9.1. 初期設定

DRMを利用するためには、マーチャント単位での有効化が必要です。有効化のためには、カスタマーサポートまでお問い合わせください。
コンテンツをiOSデバイス（Apple TVなど）やブラウザのSafariに配信したい場合は、AppleからリリースされているFairPlayデプロイメントパッケージを取得する必要があります。FairPlayデプロイメントパッケージを請求するには、AppleのデベロッパーサイトからAppleにご連絡ください。パッケージには、以下の4つの重要な情報が含まれていますので、それをカスタマーサポートに伝えてください。
通常DRMの有効化は5営業日以内に対応されます。

9.1.1. FairPlayに必要な情報

• CSR（証明書署名要求） ファイル形式: .csr
• ASK（アプリケーションシークレットキー） ファイル形式: 128bitの文字列
• 証明書 ファイル形式: .derもしくは.cer
• キー（スタンダードプレイベートキー） ファイル形式: .pem

ステージング環境においてFairplayの実装テストをしていたとしても、Apple社からプロダクション証明を取得する必要があります。

9.2. DRMライセンス有効期限

プレイヤーからの鍵リクエストに有効期限または有効期間を設定することが可能です。 鍵リクエストが有効期限外などの理由で行われなかった場合、動画再生が停止します。 有効期限、有効期間の設定は配信設定により行います。

10. サポートマニュアル

ビデオプラットフォームサービス管理画面の操作方法はサポートマニュアルを参照ください。