プレイヤー関連API

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

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/players/:player_id
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
player_idStringプレイヤーIDidplayer_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringID
ref_idString参照ID
nameStringプレイヤー名
enable_start_over_flagBoolean頭出しフラグ
enable_share_flagStringシェアフラグ
enable_embed_code_flagString埋め込みコードフラグ
twitter_conditionStringtwitterシェアフラグ
facebook_conditionObjectfacebookシェアフラグ

レスポンスの例

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_idStringマーチャントIDnttsmc必須
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringID
ref_idString参照ID
nameStringプレイヤー名
enable_start_over_flagBoolean頭出しフラグ
enable_share_flagBooleanシェアフラグ
enable_embed_code_flagBoolean埋め込みコードフラグ
twitter_conditionBooleantwitterシェアフラグ
facebook_conditionBooleanfacebookシェアフラグ

レスポンスの例

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_idStringマーチャントIDnttsmc必須
player_idStringプレイヤーIDidplayer_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
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_idStringマーチャントIDnttsmc必須
media_player_idString配信webプレイヤーIDidmedia_player_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
index_page_urlString配信webプレイヤーURL
idStringID
ref_idString参照ID
nameString配信webプレイヤー名
descriptionString説明
player_idStgingプレイヤーID
mediaObjectメディア情報
media_groupObjectメディアグループ情報
widthIntegerプレイヤー幅
heightIntegerプレイヤー高さ
iframe_embed_codeStringiframeタグ
embed_codeStringビデオタグ
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

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_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプ説明サンプル必要性
media_idStringメディアIDID任意
ref_idString参照IDid任意
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
index_page_urlString配信webプレイヤーURL
idStringID
ref_idString参照ID
nameString配信webプレイヤー名
descriptionString説明
player_idStgingプレイヤーID
mediaObjectメディア情報
media_groupObjectメディアグループ情報
widthIntegerプレイヤー幅
heightIntegerプレイヤー高さ
iframe_embed_codeStringiframeタグ
embed_codeStringビデオタグ
created_atDateString作成日時
updated_atDateString更新日時

レスポンスの例

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_idStringプレイヤーIDid必須
media_idStringメディアIDid必須
widthIntegerプレイヤー幅960必須
heightIntegerプレイヤー高さ540必須
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
index_page_urlString配信webプレイヤーURL
idString配信webプレイヤーID
ref_idString参照ID
nameString配信webプレイヤー名
descriptionString説明文
player_idStringプレイヤーID
mediaStringメディア情報
media_groupStringメディアグループ情報
widthIntegerプレイヤー幅
heightIntegerプレイヤー高さ
iframe_embed_codeStringiframeタグ
embed_codeStringビデオタグ
created_atString作成日時
updated_atString更新日時

レスポンスの例

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"
}
エラーコード
ステータスコードコードメッセージ
404MEDIA_NOT_FOUND該当するメディアが存在しません
404PLAYER_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_idStringマーチャントIDnttsmc必須
media_player_idString配信webプレイヤーIDidmedia_player_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス

レスポンスの例

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