プレイヤー関連API｜SmartSTREAM サポートマニュアル

共通処理

リクエストヘッダー

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

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

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

HTTPリクエスト

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

URLパラメータ

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

レスポンス

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

プレイヤーの一覧取得

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

HTTPリクエスト

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

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	プレイヤー名
enable_start_over_flag	Boolean	頭出しフラグ
enable_share_flag	String	シェアフラグ
enable_embed_code_flag	String	埋め込みコードフラグ
twitter_condition	String	twitterシェアフラグ
facebook_condition	Boolean	facebookシェアフラグ

レスポンスの例

HTTP/1.1 200 OK
{
  "count": ,
  "players":
  [
    {<player1 fields>},
    {<player2 fields>},
    ...
  ]
}

プレイヤーの削除

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

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

URLパラメータ

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

レスポンス

レスポンスの例

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
}

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

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

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

URLパラメータ

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

レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
index_page_url	String	配信webプレイヤーURL
id	String	ID
ref_id	String	参照ID
name	String	配信webプレイヤー名
description	String	説明
player_id	String	プレイヤー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"
}

配信WEBプレイヤーの一覧取得

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

HTTPリクエスト

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

URLパラメータ

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

クエリパラメータ

フィールド	タイプ	説明	サンプル	必要性
media_id	String	メディアID	ID	任意
ref_id	String	参照ID	id	任意
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

レスポンス

フィールド	タイプ	説明
merchant_id	String	マーチャントID
index_page_url	String	配信webプレイヤーURL
id	String	ID
ref_id	String	参照ID
name	String	配信webプレイヤー名
description	String	説明
player_id	String	プレイヤー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>},
      ...
    ]
}

配信WEBプレイヤーの作成

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

HTTPリクエスト

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

リクエスト

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

レスポンス

フィールド	タイプ	説明
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	Object	メディア情報
media_group	String	メディアグループ情報
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"
}

エラーコード

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

配信WEBプレイヤーの削除

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

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

URLパラメータ

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

レスポンス

レスポンスの例

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"
}