View, create, update and delete Vidyard players.
Thumbnails: To get the thumbnail image url of a player simply sub in the player uuid into this url: play.vidyard.com/PLAYER_UUID.jpg
Create a new player that can contain video objects
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
// There are 2 options to create a new player:
// Option 1: create a player with a single video.
{
"name":"My Player",
"chapters_attributes":[{
"position":0,
"video_attributes":{
"name":"My Video",
"upload_url":"http://myvideos.com/video.mp4"
}
}]
}
//Option 2: create a player that can contain multiple videos. Use the <a href="/apidoc/api_chapters/create.html">chapters endpoint</a> to add videos to the player.
REQUEST
Content-Type: application/json
{
"name": "My Player",
"description": "The besterest videos",
"viral_sharing": true,
"viral_sharing_message": "Check out this awesome video!",
"height": 360,
"width": 640,
"color": "A7A7A7",
"splash_screen_fade": true,
"on_complete": "loop",
"sharing_page": true,
"sharing_page_comments": true,
"whitelisted_embed_domain": "*.example.com,example2.com",
"authorized_by": "platform"
}
RESPONSE
201 (Created)
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
"description": "The besterest videos",
"play_button": true,
"autoplay": false,
"embed_button": true,
"viral_sharing": true,
"viral_sharing_message": "Check out this awesome video!",
"custom_sharing_link": null,
"height": 360,
"width": 640,
"color": "A7A7A7",
"playlist_color": "222222",
"splash_screen_fade": true,
"mute_onload": false,
"disable_playlist": false,
"playlist_always_open": false,
"audio_player_visuals": "visualization",
"on_complete": "loop",
"redirect_url": null,
"redirect_whole_page": false,
"sharing_page": true,
"sharing_page_comments": true,
"release_date": 0,
"expiry_date": null,
"whitelisted_embed_domain": "*.example.com,example2.com",
"authorized_by": "platform",
"hidden_controls": false,
"up_next": false,
"disable_legacy": false,
"chapters_attributes": [],
"created_at": 1390585689,
"updated_at": 1390585689,
"length_in_seconds": 0,
"show_playback_speed": false,
"show_time": true
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
name optional |
Name of the player Validations:
|
|
description optional |
Description of the player Validations:
|
|
play_button optional |
Display the play button on the thumbnail Validations:
|
|
autoplay optional |
Force the player to start playing when the page loads Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
embed_button optional |
Display embed button on player Validations:
|
|
viral_sharing optional |
Adds a share button to your player allowing your viewers to share your videos on social networks and email Validations:
|
|
viral_sharing_message optional |
The message used when viral sharing button is clicked Validations:
|
|
custom_sharing_link optional |
The link that will be shared when viral sharing button is clicked Validations:
|
|
height optional |
Height of the player Validations:
|
|
width optional |
Width of the player Validations:
|
|
color optional |
Color of the player (Hex) Validations:
|
|
playlist_color optional |
Color of the playlist (Hex) Validations:
|
|
splash_screen_fade optional |
The player gets highlighted when a viewer’s mouse hovers over it Validations:
|
|
mute_onload optional |
The videos will default to mute with a text overlay prompting the viewer to click for sound Validations:
|
|
disable_playlist optional |
The playlist is not shown on the side of the player Validations:
|
|
playlist_always_open optional |
The playlist is always shown on the side of the player Validations:
|
|
on_complete optional , nil allowed |
What would you like to happen when all videos have finished playing? Validations:
|
|
redirect_url optional |
URL to redirect the player iframe to when videos have finished playing Validations:
|
|
redirect_whole_page optional |
Redirects the entire page if “on_complete” is set to “redirect_url” Validations:
|
|
sharing_page optional |
Enable the sharing page for the player Validations:
|
|
sharing_page_comments optional |
Allow viewers to comment on the sharing page Validations:
|
|
release_date optional , nil allowed |
Timestamp (Unix Time) Validations:
|
|
expiry_date optional , nil allowed |
Timestamp (Unix Time) Validations:
|
|
whitelisted_embed_domain optional |
Restrict this player to be embedded only on specific domains Validations:
|
|
authorized_by optional |
Restrict this player to a specific platform such as Hubs or Salesforce Chatter Validations:
|
|
hidden_controls optional |
Disable playback controls Validations:
|
|
up_next optional |
Enable Up Next feature Validations:
|
|
disable_legacy optional |
Disable legacy mode Validations:
|
|
audio_player_visuals optional |
Change what is displayed during playback of an audio chapter Validations:
|
|
chapters_attributes optional |
Advanced feature: Used for embedded chapter resource creation Validations:
|
Get a player
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
"description": "The besterest videos",
"play_button": true,
"autoplay": false,
"embed_button": true,
"viral_sharing": true,
"viral_sharing_message": "Check out this awesome video!",
"custom_sharing_link": null,
"height": 360,
"width": 640,
"color": "A7A7A7",
"playlist_color": "222222",
"splash_screen_fade": true,
"mute_onload": false,
"disable_playlist": false,
"playlist_always_open": false,
"audio_player_visuals": "visualization",
"on_complete": "splash_screen",
"redirect_url": null,
"redirect_whole_page": false,
"sharing_page": true,
"sharing_page_comments": true,
"disable_default_events": false,
"release_date": 0,
"expiry_date": null,
"whitelisted_embed_domain": "http://*.example.com",
"authorized_by": "",
"hidden_controls": false,
"up_next": false,
"disable_legacy": false,
"chapters_attributes":[{
"position":0,
"player_id":50,
"video_id":63,
"video_attributes":{
"name":"Falcon Punch",
"upload_url":null,
"description":"A description",
"sync":true,
"audio_gain":0,
"webhook_url":null,
"tags_attributes":[],
"hosting_provider":"youtube",
"id":63,
"status":null,
"error_message":null,
"created_at":1374178204,
"updated_at":1374178204
},
"id":37,
"created_at":1374178204,
"updated_at":1374178204
}],
"created_at": 1390585689,
"updated_at": 1390585689,
"length_in_seconds": 0,
"show_playback_speed": false,
"access_setting": "public",
"show_time": true
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
Get a player by UUID
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Validations:
|
|
custom_identifier optional |
Filters the results by custom identifier. Validations:
|
Delete a player
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
Get a list of players.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
// USING PER_PAGE OR PAGE
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"players": [
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
...
},
"id": 1156,
"uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
"name": "My Player",
...
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 4
}
}
// NOT USING PER_PAGE OR PAGE
REQUEST
Accept: application/json
RESPONSE
200 (OK)
[
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
...
},
"id": 1156,
"uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
"name": "My Player",
...
}
]
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
|
order_by optional |
The attribute to order the list by Validations:
|
|
direction optional |
When the direction to order the list Validations:
|
|
query optional |
A string used to search for a set a players by player / video name as well as all associated tags Validations:
|
|
include_subgroups optional |
Include players from sub-groups Validations:
|
Add players to a category
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 409 | Conflict: Conflict with the current state of the resource |
REQUEST
Content-Type: application/json
[
145643,
125222,
234100
]
RESPONSE
200 (OK)
{
"players": [
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
...
},
"id": 1156,
"uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
"name": "My Player",
...
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 4
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get the list of players for a category
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"players": [
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
...
},
"id": 1156,
"uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
"name": "My Player",
...
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 4
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Search for players based on player properties
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Content-Type: application/json
{
"mute_onload": false,
"pause_disabled": true,
"height": 360,
"width": 400,
"splash_screen_fade": true,
"color": "#ffffff",
"sharing_page_comments": true,
"play_button": true,
"sharing_page": true,
"embed_button": true,
"playlist_color": "#ffffff",
"autoplay": false,
"viral_sharing": false,
"viral_sharing_message": "Check out this cool video!",
"custom_sharing_link": "www.vidyard.com",
"authorized_by": null,
"hidden_controls": false,
"up_next": false,
"custom_attribute_name": "internal_name",
"custom_attribute_value": "new internal product launch"
}
RESPONSE
200 (OK)
[
"players": [
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
...
},
"id": 1156,
"uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
"name": "My Player",
...
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 4
}
]
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
name optional |
Filters players based on specified player name (exact match only) Validations:
|
|
mute_onload optional |
Filters players based on specified mute_onload value Validations:
|
|
pause_disabled optional |
Filters players based on specified pause_disabled value Validations:
|
|
height optional |
Filters players based on specified height value Validations:
|
|
width optional |
Filters players based on specified width value Validations:
|
|
splash_screen_fade optional |
Filters players based on specified splash_screen_fade value Validations:
|
|
color optional |
Filters players based on player colour value Validations:
|
|
play_button_color optional |
Filters players based on play button colour value Validations:
|
|
sharing_page_comments optional |
Filters players based on specified sharing_page_comments value Validations:
|
|
play_button optional |
Filters players based on specified play_button value Validations:
|
|
sharing_page optional |
Filters players based on specified sharing_page value Validations:
|
|
embed_button optional |
Filters players based on specified embed_button value Validations:
|
|
playlist_color optional |
Filters players based on specified playlist_color value Validations:
|
|
autoplay optional |
Filters players based on specified autoplay value Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
viral_sharing optional |
Filters players based on specified viral_sharing value Validations:
|
|
viral_sharing_message optional |
Filters players based on specified viral_sharing_message value Validations:
|
|
custom_sharing_link optional |
Filters players based on specified custom_sharing_link value Validations:
|
|
hidden_controls optional |
Filters players based on specific hidden_controls value Validations:
|
|
up_next optional |
Filters players based on Up Next feature Validations:
|
|
disable_legacy optional |
Filters players based on allowance of legacy mode Validations:
|
|
custom_attribute_name optional |
Filters players based on specific custom attribute, must be used in conjunction with custom_attribute_value Validations:
|
|
custom_attribute_value optional |
Filters players based on specific custom attribute value, must be used in conjunction with custom_attribute_name Validations:
|
|
order_by optional |
Set the property to order the results of the search Validations:
|
|
direction optional |
Direction of the sorting of results Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Update a player
IMPORTANT CHANGE TO ENDPOINT: The following parameters in this endpoint can now only be used if player_type = playlist - “playlist_always_open”, “on_complete”, “redirect_url”, “redirect_whole_page”, “up_next”
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Validations:
|
Update a player
IMPORTANT CHANGE TO ENDPOINT: The following parameters in this endpoint can now only be used if player_type = playlist - “playlist_always_open”, “on_complete”, “redirect_url”, “redirect_whole_page”, “up_next”
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
REQUEST
Content-Type: application/json
{
"play_button": false,
"autoplay": true,
"mute_onload": true,
"embed_button": false,
"whitelisted_embed_domain": "*.example.com"
}
RESPONSE
200 (OK)
{
"id": 1111,
"uuid": "eQSsPVXinqGoesujP2Vteg",
"name": "My Player",
"description": "The besterest videos",
"play_button": false,
"autoplay": true,
"embed_button": false,
"viral_sharing": true,
"viral_sharing_message": "Check out this awesome video!",
"custom_sharing_link": null,
"height": 360,
"width": 640,
"color": "A7A7A7",
"playlist_color": "222222",
"splash_screen_fade": true,
"mute_onload": true,
"up_next": false,
"disable_playlist": false,
"playlist_always_open": false,
"audio_player_visuals": "visualization",
"on_complete": "loop",
"redirect_url": null,
"redirect_whole_page": false,
"sharing_page": true,
"sharing_page_comments": true,
"release_date": 0,
"expiry_date": null,
"whitelisted_embed_domain": "*.example.com",
"chapters_attributes":[{
"position":0,
"player_id":50,
"video_id":63,
"video_attributes":{
"name":"Falcon Punch",
"upload_url":null,
"description":"A description",
"sync":true,
"audio_gain":0,
"webhook_url":null,
"tags_attributes":[],
"hosting_provider":"youtube",
"id":63,
"status":null,
"error_message":null,
"created_at":1374178204,
"updated_at":1374178204
},
"id":37,
"created_at":1374178204,
"updated_at":1374178204
}],
"created_at": 1390585689,
"updated_at": 1390585689,
"length_in_seconds": 0,
"show_playback_speed": false,
"access_setting": "public",
"show_time": true
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
|
name optional |
Name of the player Validations:
|
|
description optional |
Description of the player Validations:
|
|
play_button optional |
Display the play button on the thumbnail Validations:
|
|
autoplay optional |
Force the player to start playing when the page loads Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
embed_button optional |
Display embed button on player Validations:
|
|
viral_sharing optional |
Adds a share button to your player allowing your viewers to share your videos on social networks and email Validations:
|
|
viral_sharing_message optional |
The message used when viral sharing button is clicked Validations:
|
|
custom_sharing_link optional |
The link that will be shared when viral sharing button is clicked Validations:
|
|
height optional |
Height of the player Validations:
|
|
width optional |
Width of the player Validations:
|
|
color optional |
Color of the player (Hex) Validations:
|
|
playlist_color optional |
Color of the playlist (Hex) Validations:
|
|
splash_screen_fade optional |
The player gets highlighted when a viewer’s mouse hovers over it Validations:
|
|
mute_onload optional |
The videos will default to mute with a text overlay prompting the viewer to click for sound Validations:
|
|
disable_playlist optional |
The playlist is not shown on the side of the player Validations:
|
|
playlist_always_open optional |
The playlist is always shown on the side of the player Validations:
|
|
on_complete optional , nil allowed |
What would you like to happen when all videos have finished playing? Validations:
|
|
redirect_url optional |
URL to redirect the player iframe to when videos have finished playing Validations:
|
|
redirect_whole_page optional |
Redirects the entire page if “on_complete” is set to “redirect_url” Validations:
|
|
sharing_page optional |
Enable the sharing page for the player Validations:
|
|
sharing_page_comments optional |
Allow viewers to comment on the sharing page Validations:
|
|
release_date optional , nil allowed |
Timestamp (Unix Time) Validations:
|
|
expiry_date optional , nil allowed |
Timestamp (Unix Time) Validations:
|
|
whitelisted_embed_domain optional |
Restrict this player to be embedded only on specific domains Validations:
|
|
authorized_by optional |
Restrict this player to a specific platform such as Hubs or Salesforce Chatter Validations:
|
|
hidden_controls optional |
Disable playback controls Validations:
|
|
up_next optional |
Enable Up Next feature Validations:
|
|
disable_legacy optional |
Disable legacy mode Validations:
|
|
audio_player_visuals optional |
Change what is displayed during playback of an audio chapter Validations:
|
Create an Access Code for Player
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Content-Type: application/json
{
"max_uses": 1
}
RESPONSE
201 (Created)
{
"value": "mI2y0ez1",
"expiry_date": 0,
"max_uses": 1,
"creation_method": "access_request",
"id": 11,
"created_at": 1431026485,
"updated_at": 1431026485,
"player_id": 39
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
max_uses optional |
Set a maximum use limit for the access code Validations:
|
|
value optional |
The access code value Validations:
|
|
expiry_date optional |
Set expiry date for the access code Validations:
|
Get a player’s embed codes. Any parameter not specified will default to the settings chosen for the player.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"inline": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=inline\"></script>",
"light_box": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=lightbox\"></script><div><div class=\"vidyard_wrapper\" onclick=\"fn_vidyard_w1rHLYXjgE0qq7i9PW6HLA();\"><img width=\"360\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?\" alt=\"Player\"><div class=\"vidyard_play_button\"><a href=\"javascript:void(0);\"></a></div></div></div>",
"iframe": "<iframe class=\"vidyard_iframe\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.0\" width=\"640\" height=\"360\" scrolling=\"no\" frameborder=\"0\" allowtransparency=\"true\"></iframe>",
"sharing_page": "http://secure.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw",
"branded_sharing_page": "http://company.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw",
"url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.1.1",
"base_url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html",
"thumbnail": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
|
custom_id optional |
When specified (and applicable) will load the specified instance of the player Validations:
|
|
disable_popouts optional |
Turns off Popout Call to Actions so they will not display in the player Validations:
|
|
disable_redirect optional |
Disable the player from redirecting if it is set to redirect on player completion Validations:
|
|
up_next optional |
Turn off showing what’s Up next, only available if playlist_always_open is false Validations:
|
|
disable_playlist optional |
Turn off the Playlist so it will not be displayed Validations:
|
|
playlist_always_open optional |
If there are multiple chapters in the player the playlist will be permanently visible Validations:
|
|
autoplay optional |
Causes the playlist to begin playing as soon as it has loaded Validations:
|
|
control_360 optional |
Show 360 controls for a 360 videos Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
viral_sharing optional |
Displays the social sharing buttons on the player Validations:
|
|
embed_button optional |
Displays the embed button on the player Validations:
|
|
hide_playlist optional |
Disables the playlist in the player Validations:
|
|
hide_html5_playlist optional |
Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues. Validations:
|
|
name_overlay optional |
Overlays the name of the video at the top of the player Validations:
|
|
video_id optional |
When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property. Validations:
|
|
chapter optional |
When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property. Validations:
|
|
lightbox_href_text optional |
The text to used in in the embed code for lightbox Validations:
|
|
include_sharing_page optional |
Whether or not to include the embed code for the sharing page Validations:
|
|
include_branded_sharing_page optional |
Whether or not to include the embed code for the branded sharing page Validations:
|
Get a player’s embed codes by UUID. Any parameter not specified will default to the settings chosen for the player.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Validations:
|
|
custom_id optional |
When specified (and applicable) will load the specified instance of the player Validations:
|
|
disable_popouts optional |
Turns off Popout Call to Actions so they will not display in the player Validations:
|
|
disable_redirect optional |
Disable the player from redirecting if it is set to redirect on player completion Validations:
|
|
up_next optional |
Turn off showing what’s Up next, only available if playlist_always_open is false Validations:
|
|
disable_playlist optional |
Turn off the Playlist so it will not be displayed Validations:
|
|
playlist_always_open optional |
If there are multiple chapters in the player the playlist will be permanently visible Validations:
|
|
autoplay optional |
Causes the playlist to begin playing as soon as it has loaded Validations:
|
|
control_360 optional |
Show 360 controls for a 360 videos Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
viral_sharing optional |
Displays the social sharing buttons on the player Validations:
|
|
embed_button optional |
Displays the embed button on the player Validations:
|
|
hide_playlist optional |
Disables the playlist in the player Validations:
|
|
hide_html5_playlist optional |
Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues. Validations:
|
|
name_overlay optional |
Overlays the name of the video at the top of the player Validations:
|
|
video_id optional |
When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property. Validations:
|
|
chapter optional |
When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property. Validations:
|
|
lightbox_href_text optional |
The text to used in in the embed code for lightbox Validations:
|
|
include_sharing_page optional |
Whether or not to include the embed code for the sharing page Validations:
|
|
include_branded_sharing_page optional |
Whether or not to include the embed code for the branded sharing page Validations:
|
Create a player embed code (supports emails). Any parameter not specified will default to the settings chosen for the player.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
{
"vyemail": "vbot@vidyard.com"
}
RESPONSE
200 (OK)
{
"responsive_inline": "<script type=\"text/javascript\" async src=\"https://play.vidyard.com/embed/v4.js\"></script>\n<img\n style=\"width: 100%; margin: auto; display: block;\"\n class=\"vidyard-player-embed\"\n src=\"https://play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg\"\n data-uuid=\"w1rHLYXjgE0qq7i9PW6HLA\"\n data-v=\"4\"\n data-type=\"inline\"\n/>",
"responsive_lightbox": "<script type=\"text/javascript\" async src=\"https://play.vidyard.com/embed/v4.js\"></script>\n<img\n style=\"width: 100%; margin: auto; display: block;\"\n class=\"vidyard-player-embed\"\n src=\"https://play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg\"\n data-uuid=\"w1rHLYXjgE0qq7i9PW6HLA\"\n data-v=\"4\"\n data-type=\"lightbox\"\n/>",
"inline": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=inline&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\"></script>",
"light_box": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=lightbox&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\"></script><div><div class=\"vidyard_wrapper\" onclick=\"fn_vidyard_w1rHLYXjgE0qq7i9PW6HLA();\"><img width=\"360\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?\" alt=\"Player\"><div class=\"vidyard_play_button\"><a href=\"javascript:void(0);\"></a></div></div></div>",
"iframe": "<iframe class=\"vidyard_iframe\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.0&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\" width=\"640\" height=\"360\" scrolling=\"no\" frameborder=\"0\" allowtransparency=\"true\"></iframe>",
"sharing_page": "http://secure.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw?vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",
"branded_sharing_page": "http://company.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw?vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",
"url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.1.1&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",
"base_url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html",
"thumbnail": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
|
vyemail optional |
Personalizes the embed codes to the given email (will add vyetoken representing the email). Validations:
|
|
custom_id optional |
When specified (and applicable) will load the specified instance of the player Validations:
|
|
disable_popouts optional |
Turns off Popout Call to Actions so they will not display in the player Validations:
|
|
disable_redirect optional |
Disable the player from redirecting if it is set to redirect on player completion Validations:
|
|
up_next optional |
Turn off showing what’s Up next, only available if playlist_always_open is false Validations:
|
|
disable_playlist optional |
Turn off the Playlist so it will not be displayed Validations:
|
|
playlist_always_open optional |
If there are multiple chapters in the player the playlist will be permanently visible Validations:
|
|
autoplay optional |
Causes the playlist to begin playing as soon as it has loaded Validations:
|
|
control_360 optional |
Show 360 controls for a 360 videos Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
viral_sharing optional |
Displays the social sharing buttons on the player Validations:
|
|
embed_button optional |
Displays the embed button on the player Validations:
|
|
hide_playlist optional |
Disables the playlist in the player Validations:
|
|
hide_html5_playlist optional |
Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues. Validations:
|
|
name_overlay optional |
Overlays the name of the video at the top of the player Validations:
|
|
video_id optional |
When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property. Validations:
|
|
chapter optional |
When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property. Validations:
|
|
lightbox_href_text optional |
The text to used in in the embed code for lightbox Validations:
|
|
include_sharing_page optional |
Whether or not to include the embed code for the sharing page Validations:
|
|
include_branded_sharing_page optional |
Whether or not to include the embed code for the branded sharing page Validations:
|
Create a player embed codes by UUID (supports email personalization). Any parameter not specified will default to the settings chosen for the player.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Validations:
|
|
vyemail optional |
Personalizes the embed codes to the given email (will add vyetoken representing the email). Validations:
|
|
custom_id optional |
When specified (and applicable) will load the specified instance of the player Validations:
|
|
disable_popouts optional |
Turns off Popout Call to Actions so they will not display in the player Validations:
|
|
disable_redirect optional |
Disable the player from redirecting if it is set to redirect on player completion Validations:
|
|
up_next optional |
Turn off showing what’s Up next, only available if playlist_always_open is false Validations:
|
|
disable_playlist optional |
Turn off the Playlist so it will not be displayed Validations:
|
|
playlist_always_open optional |
If there are multiple chapters in the player the playlist will be permanently visible Validations:
|
|
autoplay optional |
Causes the playlist to begin playing as soon as it has loaded Validations:
|
|
control_360 optional |
Show 360 controls for a 360 videos Validations:
|
|
first_frame optional |
Causes the player to begin playing as soon as it has loaded and then immediately pause Validations:
|
|
viral_sharing optional |
Displays the social sharing buttons on the player Validations:
|
|
embed_button optional |
Displays the embed button on the player Validations:
|
|
hide_playlist optional |
Disables the playlist in the player Validations:
|
|
hide_html5_playlist optional |
Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues. Validations:
|
|
name_overlay optional |
Overlays the name of the video at the top of the player Validations:
|
|
video_id optional |
When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property. Validations:
|
|
chapter optional |
When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property. Validations:
|
|
lightbox_href_text optional |
The text to used in in the embed code for lightbox Validations:
|
|
include_sharing_page optional |
Whether or not to include the embed code for the sharing page Validations:
|
|
include_branded_sharing_page optional |
Whether or not to include the embed code for the branded sharing page Validations:
|
Get a player’s download links.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
[
{ chapter_id: "1",
download_links: {
"source": "s3://vidyard-staging/videos/QP90ckulv-DnY33gwwvX9Q/source.mp4",
"sd": "s3://vidyard-staging/videos/QP90ckulv-DnY33gwwvX9Q/sd.mp4",
"hd": "s3://vidyard-staging/videos/QP90ckulv-DnY33gwwvX9Q/hd.mp4",
}
},
{ chapter_id: "2",
download_links: {
"source": "s3://vidyard-staging/videos/ZP90ckulv-DnY33gwwvX9Q/source.mp4",
"sd": "s3://vidyard-staging/videos/ZP90ckulv-DnY33gwwvX9Q/sd.mp4"
}
}
]
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get a player’s download links by UUID.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Validations:
|
DEPRECATED
Push a player to YouTube
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
REQUEST
Content-Type: application/json
{
"channel_id": "GGh3dAgDwNXR1whyLT1a5MfA",
"scheduled_timestamp": "1374178204",
"privacy_setting": "private",
"embeddable_setting": true
}
RESPONSE
200 (OK)
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
|
channel_id required |
YouTube channel id Validations:
|
|
privacy_setting optional |
YouTube privacy setting Validations:
|
|
embeddable_setting optional |
Whether the youtube videos created for this player can be embedded in iframes Validations:
|
|
scheduled_timestamp optional |
Timestamp (Unix Time) Validations:
|
Duplicate player.
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST Accept: application/json RESPONSE 202 (ACCEPTED) [ "player_status": "duplicating", ]
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
The UUID of the player you want to duplicate Validations:
|
|
organization_id optional , nil allowed |
The organization the player will be copied to Validations:
|
|
player_name optional |
The name which should be given to the duplicate player Validations:
|
Get default player options
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"mute_onload": false,
"playlist_style": "default",
"context_menu": true,
"pause_disabled": false,
"height": 360,
"width": 640,
"splash_screen_fade": true,
"color": "7DC577",
"play_button": true,
"embed_button": true,
"playlist_color": "222222",
"autoplay": false,
"ignore_organization_ip_whitelist": null,
"name_overlay": null,
"caption_display": "optional",
"play_button_color": "2e2e2e",
"hidden_controls": false,
"render_scrubber_thumbnail": true,
"authorized_by": "",
"audio_player_visuals": "visualization",
"background_style": "black",
"up_next": true,
"disable_default_events": false,
"end_chapter_pause": false,
"disable_legacy": false,
"disable_live_dvr": false,
"playlist_always_open": false,
"disable_playlist": false,
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|