SmartSTREAM logo

SmartSTREAM Support Manual

Return to Support Manual TOP

Player-Related API

Common Processing

Request Headers

Please refer here for request headers.

Retrieve Player by ID or Reference ID

API to retrieve a single player by specifying the ID or reference ID.

HTTP Request

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

URL Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
player_id String Player ID id Either player_id or ref_id required
ref_id String Reference ID id  

Response

Field Type Description
merchant_id String Merchant ID
id String ID
ref_id String Reference ID
name String Player Name
enable_start_over_flag Boolean Start-over flag
enable_share_flag String Share flag
enable_embed_code_flag String Embed code flag
twitter_condition String Twitter share flag
facebook_condition Object Facebook share flag

Response Example

HTTP/1.1 200 OK
{
"merchant_id":"logiclogic",
"id":"ab817b0d64d648e580f74bee47d7959f",
"ref_id":null,
"name":"Test Player",
"enable_start_over_flag":false,
"enable_share_flag":false,
"enable_embed_code_flag":false,
"twitter_condition":null,
"facebook_condition":null
}

Retrieve Player List

This API retrieves player information.

HTTP Request

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

URL Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required

Query parameters

Field Type Description Example
limit Integer Number of records to retrieve 30
page Integer Page number 1
sort String Sort column updated_at
order String Sort order ASC

Response

Field Type Description
merchant_id String Merchant ID
id String ID
ref_id String Reference ID
name String Player Name
enable_start_over_flag Boolean Start-over flag
enable_share_flag String Share flag
enable_embed_code_flag String Embed code flag
twitter_condition String Twitter share flag
facebook_condition Boolean Facebook share flag

Response Example

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

Delete Player

This API deletes a player. Any streaming web players created based on the deleted player will also be deleted.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
player_id String Media ID id Either player_id or ref_id required
ref_id String Reference ID id  

Response

Response Example

HTTP/1.1 200 OK
{
    "merchant_id":"logiclogic",
    "id":"ab817b0d64d648e580f74bee47d7959f",
    "ref_id":null,
    "name":"Test Player",
    "enable_start_over_flag":false,
    "enable_share_flag":false,
    "enable_embed_code_flag":false,
    "twitter_condition":null,
    "facebook_condition":null
}

Retrieve Streaming Web Player by ID or Reference ID

This API retrieves a single streaming web player by specifying either the ID or the reference ID.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
media_player_id String Streaming web player ID id Either media_player_id or ref_id required
ref_id String Reference ID id  

Response

Field Type Description
merchant_id String Merchant ID
index_page_url String Streaming web player URL
id String ID
ref_id String Reference ID
name String Streaming web player name
description String Description
player_id String Player ID
media Object Media information
media_group Object Media group information
width Integer Player width
height Integer Player height
iframe_embed_code String iframe tag
embed_code String Video tag
created_at DateString Created date and time
updated_at DateString Updated date and time

Response Example

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": "Sample",
  "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"
}

Retrieve Streaming Web Player List

This API retrieves streaming web player information. If a media ID or media reference ID is specified in the query parameters, a list of streaming web players created based on the specified media can be retrieved.

HTTP Request

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

URL Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required

Query parameters

Field Type Description Example Required
media_id String Media ID ID Optional
ref_id String Reference ID id Optional
limit Integer Number of records to retrieve 30  
page Integer Page number 1  
sort String Sort column updated_at  
order String Sort order ASC  

Response

Field Type Description
merchant_id String Merchant ID
index_page_url String Streaming web player URL
id String ID
ref_id String Reference ID
name String Streaming web player name
description String Description
player_id String Player ID
media Object Media information
media_group Object Media group information
width Integer Player width
height Integer Player height
iframe_embed_code String iframe tag
embed_code String Video tag
created_at DateString Created date and time
updated_at DateString Updated date and time

Response Example

HTTP/1.1 200 OK
{
  "count": 10,
  "media_players":
    [
      {<media_player1 fields>},
      {<media_player2 fields>},
      ...
    ]
}

Create Streaming Web Player

This API creates a streaming web player.

HTTP Request

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

Request

Field Type Description Example Required
player_id String Player ID id Required
media_id String Media ID id Required
width Integer Player width 960 Required
height Integer Player height 540 Required

Response

Field Type Description
merchant_id String Merchant ID
index_page_url String Streaming web player URL
id String Streaming web player ID
ref_id String Reference ID
name String Streaming web player name
description String Description
player_id String Player ID
media Object Media information
media_group String Media group information
width Integer Player width
height Integer Player height
iframe_embed_code String iframe tag
embed_code String Video tag
created_at DateString Created date and time
updated_at DateString Updated date and time

Response Example

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": "Sample",
  "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"
}

Error Codes

Status Code Code Message
404 MEDIA_NOT_FOUND The specified media does not exist
404 PLAYER_NOT_FOUND The specified player does not exist

Delete Streaming Web Player

This is the API to delete a streaming web player.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
media_player_id String Streaming web player ID id Either media_player_id or ref_id required
ref_id String Reference ID id  

Response

Response Example

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": "Sample",
  "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"
}