Version 8.3.8

Back | 

WsEmbed

Returns embed code for the vod project or live event or an asset. Embed code is url and base64 encoded. URL decode and base64 decode to get the embed

URL Format

/ws/ws_embed/api/{app_token}/mode/json/apiv/5?p={project_uuid}&v={program_uuuid}&e={event_uuid}&s={series_token}&assetid={assetid}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
catid int The id of the category to search for, if working with a category project.
v string The program uuid of the program
catid string category id for a category project
e string event uuid for a live event
s string series token for a live event
assetid string assetid of the asset
p string project_uuid The uuid of the vod project for which the embed is requested

Request Headers

Name

Possible Responses

Example Response

{
  "response": {
    "WsEmbedResponse": {
      "embedcode": "PHNjcmlwdCB0eXBlPSJ0ZXh0L2phdmFzY3JpcHQiIHNyYz0iaHR0cDovL3FhLWFzcGxheWVyLnBpa3NlbC5jb20vL2tpY2tGbGFzaC9zY3JpcHRzL3N3Zm9iamVjdDIuanM%2FMiI%2BPC9zY3JpcHQ%2BCjxzY3JpcHQgdHlwZT0idGV4dC9qYXZhc2NyaXB0IiBzcmM9Imh0dHA6Ly9xYS1vdnAucGlrc2VsLmNvbS9qc2FwaS9jb21tb25GdW5jdGlvbnMuanMiPjwvc2NyaXB0Pgo8c2NyaXB0IHR5cGU9InRleHQvamF2YXNjcmlwdCI%2BCnZhciBjYXRlZ29yeUlkPUtpdENsb3VkQVBJLnBhcnNlUXVlcnlTdHJpbmdBcnJheShBcnJheSgiY2F0ZWdvcnlJZCIsImNhdGlkIikpO3ZhciB2aWRlb191dWlkPUtpdENsb3VkQVBJLnBhcnNlUXVlcnlTdHJpbmcoInZpZGVvX3V1aWQiKTsoZnVuY3Rpb24oKXsKdmFyIGZsYXNodmFycyA9e2F1dG9QbGF5OiJmYWxzZSIscmV2aXNpb246IjEiLHNjYWxlTU9ERToibGV0dGVyYm94Iix3aWR0aDoiOTkwIixoZWlnaHQ6IjUyMCIsZ2V0RW1iZWQ6Imh0dHAlM0EvL3FhLW92cC5waWtzZWwuY29tL3dzL2dldF9hcHBzdHVkaW9fZW1iZWQvdjEvdm9kcHJvamVjdC9wcm9qZWN0X3V1aWQvbTdvNTRsZjMueG1sIixzcmM6Imh0dHAlM0EvL3FhLW92cC5waWtzZWwuY29tL3RlbXBsYXRlcy9BcHBTdHVkaW8vQ3VzdG9tUGxheWVyLzAvMC96MjF4MGM2Mi96MjF4MGM2Mi5qc29uIixhbmFseXRpY3NDb25maWdVUkw6Imh0dHAlM0EvL3BsYXllci5waWtzZWwuY29tL3RlbXBsYXRlcy9NZWRpYUFuYWx5dGljcy9NZWRpYVN1aXRlUHJvZE9uRGVtYW5kLnhtbCIsY2xpZW50QVBJOiI1MjIyMDVmMC1kZjVhLTExZTMtOGExOS0wMDUwNTY4NjJjZjkiLHNlcnZpY2VCYXNlOiJodHRwJTNBLy9xYS1vdnAucGlrc2VsLmNvbSIscHJvamVjdFVVSUQ6Im03bzU0bGYzIix2aWRlb191dWlkOnZpZGVvX3V1aWQsY2F0ZWdvcnlJZDpjYXRlZ29yeUlkfSwKIHBhcmFtcyA9e21vdmllOiJodHRwJTNBLy9xYS1hc2Fzc2V0LnBpa3NlbC5jb20vLy9hcHAvQXBwTG9hZGVyLnN3ZiIscGx1Z2luc3BhZ2U6Imh0dHAlM0EvL3d3dy5hZG9iZS5jb20vZ28vZ2V0Zmxhc2hwbGF5ZXIiLGFsaWduOiJtaWRkbGUiLGFsbG93c2NyaXB0QWNjZXNzOiJhbHdheXMiLHF1YWxpdHk6ImhpZ2giLGFsbG93RnVsbFNjcmVlbjoidHJ1ZSIsd21vZGU6InRyYW5zcGFyZW50IixiZ2NvbG9yOiIjRkZGRkZGIixtZW51OiJmYWxzZSIsYWxsb3dGdWxsU2NyZWVuSW50ZXJhY3RpdmU6InRydWUiIH0sCmV4cHJlc3NJbnN0YWxsVVJMID0gImh0dHA6Ly9xYS1hc3BsYXllci5waWtzZWwuY29tLy9raWNrRmxhc2gvc2NyaXB0cy9leHByZXNzSW5zdGFsbDIuc3dmPzIiLApzd2ZVUkwgPSAiaHR0cDovL3FhLWFzYXNzZXQucGlrc2VsLmNvbS8vL2FwcC9BcHBMb2FkZXIuc3dmIiwKYXR0cmlidXRlcz17aWQgOiJraWNrV2lkZ2V0X21lZGlhc3VpdGVfbTdvNTRsZjMiLCBuYW1lOiJraWNrV2lkZ2V0X21lZGlhc3VpdGVfbTdvNTRsZjMifSwKY2FsbGJhY2sgPSBmdW5jdGlvbihlKXsgaWYgKGUuc3VjY2Vzcz09ZmFsc2UpeyB2YXIgaWZyYW1lSGVpZ2h0ID0gIjUyMCI7IHZhciBpZnJhbWVXaWR0aCA9ICI5OTAiOyBpZigobmF2aWdhdG9yLnVzZXJBZ2VudC5pbmRleE9mKCJpUGFkIikgIT09IC0xIHx8IG5hdmlnYXRvci51c2VyQWdlbnQuaW5kZXhPZigiaVBob25lIikgIT09IC0xKSAmJiBpZnJhbWVIZWlnaHQ9PSIxMDAlIil7IHZhciBlbWJlZERpdiA9IGRvY3VtZW50LmdldEVsZW1lbnRCeUlkKCJlbV9jb250YWluZXIiKTsgIHNldEludGVydmFsKHJlc2l6ZVBsYXllciwgMzAwKTsgaWZyYW1lSGVpZ2h0ID0gZW1iZWREaXYuY2xpZW50SGVpZ2h0ICsgInB4IjsgaWZyYW1lV2lkdGggPSBlbWJlZERpdi5jbGllbnRXaWR0aCArICJweCI7IH0KCQkJCQkJCQkJCQkJCWRvY3VtZW50LmdldEVsZW1lbnRCeUlkKCJhbHRDb250ZW50RGl2X203bzU0bGYzIikuaW5uZXJIVE1MID0nPGlmcmFtZSBzcmM9Imh0dHA6Ly9xYS1hc3BsYXllci5waWtzZWwuY29tL2tpY2tGbGFzaC9qcy9jb21waWxlci92Mi9pZnJhbWUuaHRtbD9hZmZpbGlhdGVTaXRlSWQ9bWVkaWFzdWl0ZV83MyZhbXA7YXV0b1BsYXk9ZmFsc2UmYW1wO3JldmlzaW9uPTEmYW1wO3NjYWxlTU9ERT1sZXR0ZXJib3gmYW1wO2dldEVtYmVkPWh0dHAlM0EvL3FhLW92cC5waWtzZWwuY29tL3dzL2dldF9hcHBzdHVkaW9fZW1iZWQvdjEvdm9kcHJvamVjdC9wcm9qZWN0X3V1aWQvbTdvNTRsZjMueG1sJmFtcDthbmFseXRpY3NDb25maWdVUkw9aHR0cCUzQS8vcGxheWVyLnBpa3NlbC5jb20vdGVtcGxhdGVzL01lZGlhQW5hbHl0aWNzL01lZGlhU3VpdGVQcm9kT25EZW1hbmQueG1sJmFtcDtjbGllbnRBUEk9NTIyMjA1ZjAtZGY1YS0xMWUzLThhMTktMDA1MDU2ODYyY2Y5JmFtcDtzZXJ2aWNlQmFzZT1odHRwJTNBLy9xYS1vdnAucGlrc2VsLmNvbSZhbXA7cHJvamVjdFVVSUQ9bTdvNTRsZjMmYW1wO3ZpZGVvX3V1aWQ9Jyt2aWRlb191dWlkKycmYW1wO2NhdGVnb3J5SWQ9JytjYXRlZ29yeUlkKycmYW1wO3dpZGdldElkPXoyMXgwYzYyJmFtcDt3aWRnZXRIb3N0PXNlcnZlLmEtd2lkZ2V0LmNvbSZhbXA7c3JjPWh0dHAlM0EvL3FhLW92cC5waWtzZWwuY29tL3dzL2dldF9hcHBzdHVkaW9fcGxheWVyX2pzb24vY2FsbGJhY2svS2lja1V0aWxzLnNjcmlwdExvYWRDYWxsYmFja3MlNWIwJTVkL3oyMXgwYzYyLmpzb24mYW1wO3JlZmVycmFsVXJsPScrZXNjYXBlKGRvY3VtZW50LnJlZmVycmVyKSsnIiBoZWlnaHQ9JytpZnJhbWVIZWlnaHQrJyIgd2lkdGg9IicraWZyYW1lV2lkdGgrJyIgZnJhbWVib3JkZXI9IjAiIHNjcm9sbGluZz0ibm8iIHN0eWxlPSJib3JkZXI6bm9uZTtvdmVyZmxvdzpoaWRkZW47d2lkdGg6JytpZnJhbWVXaWR0aCsnO2hlaWdodDonK2lmcmFtZUhlaWdodCsnIiBhbGxvd2Z1bGxzY3JlZW4%2BPC9pZnJhbWU%2BJyB9IH07CnN3Zm9iamVjdC5lbWJlZFNXRihzd2ZVUkwsICJhbHRDb250ZW50RGl2X203bzU0bGYzIiwgIjk5MCIsICI1MjAiLCAiMTAiLCBleHByZXNzSW5zdGFsbFVSTCwgZmxhc2h2YXJzLCBwYXJhbXMsIGF0dHJpYnV0ZXMsIGNhbGxiYWNrKTsKfSkoKTsKPC9zY3JpcHQ%2BCjwhLS0gUHV0IHRoaXMgPGRpdj4gYW55d2hlcmUgaW4gdGhlIDxib2R5PiBvZiB5b3VyIHBhZ2Ugd2hlcmUgeW91IHdhbnQgdGhlIHdpZGdldCB0byBzaG93IHVwLiAtLT4KPGRpdiBpZD0iZW1fY29udGFpbmVyIiBjbGFzcz0iZW1iZWQtY29udGFpbmVyIj48ZGl2IGlkPSJhbHRDb250ZW50RGl2X203bzU0bGYzIj48L2Rpdj48L2Rpdj4%3D",
      "iframeEmbed": "PGlmcmFtZSBmcmFtZWJvcmRlcj0iMCIgc2Nyb2xsaW5nPSJubyIgYWxpZ249Im1pZGRsZSINCgkJCQkJCQkJc3JjPSJodHRwOi8vcWEtb3ZwLnBpa3NlbC5jb20vcC9tN281NGxmMyINCgkJCQkJCQkJaGVpZ2h0PSI1MjAiIHdpZHRoPSI5OTAiDQoJCQkJCQkJCWFsbG93dHJhbnNwYXJlbmN5PSJ0cnVlIiBhbGxvd2Z1bGxzY3JlZW4%2BDQoJCQkJCQkJPC9pZnJhbWU%2B"
    },
    "success": {
      "code": 884,
      "message": "Embed code found",
      "details": ""
    }
  }
}