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:
|