OEMBED API (ENG)
INTRODUCTION
This API is used to query for oEmbed objects for video page URL(s) on Icareus Suite sites.
API PATH
/api/oembed
API
GET OEMBED OBJECT
REQUEST
/api/oembed
Parameters:
| Name | Value | Requirement | Info |
|---|---|---|---|
| url | string | Mandatory | URL of the video player page to get the embed content/format for. Url must contain a valid assetId |
| format | string | Optional | Can only be json. Will use json if missing |
| maxWidth | number | Optional | Pixel width of the embed object (must be given if maxHeight parameter is given) |
| maxHeight | number | Optional | Pixel height of the embed object (must be given if maxWidth parameter is given) |
RESPONSE
SUCCESS RESPONSE(S)
Response Status Code: 200
{ "thumbnail_height": 400, "thumbnail_width": 600, "height": 400, "width": 600, "html": "<object data=\"http://suite.icareus.com/web/tvanywhere-demo/player/embed/vod?assetId=449690\" width=\"600\" height=\"400\" ><embed data=\"http://suite.icareus.com/web/tvanywhere-demo/player/embed/vod?assetId=449690\" width=\"600\" height=\"400\" ></embed></object>", "type": "video", "provider_name": "Icareus Suite", "version": "1.0"} |
Response Status Code: 200
{ "thumbnail_height": ?720, "thumbnail_width": 1280, "html": "<object data=\"http://suite.icareus.com/web/tvanywhere-demo/player/embed/vod?assetId=449690\" width=\"100%\" height=\"100%\" ><embed data=\"http://suite.icareus.com/web/tvanywhere-demo/player/embed/vod?assetId=449690\" width=\"100%\" height=\"100%\" ></embed></object>", "type": "video", "provider_name": "Icareus Suite", "version": "1.0"} |
ERROR RESPONSE(S)
INCORRECT ASSETID IN URL
http://suite.icareus.com/api/oembed?url=http://suite.icareus.com/web/tvanywhere-demo/series?assetId=112233&format=json&maxWidth=600&maxHeight=400
Response Status Code: 404
{} |
INCORRECT FORMAT VALUE
http://suite.icareus.com/api/oembed?url=http://suite.icareus.com/web/tvanywhere-demo/series?assetId=449690&format=xml&maxWidth=600&maxHeight=400
Response Status Code: 501
{} |
Related Articles
Analytics API (ENG)
INTRODUCTION This API stores video access/usage statistics for the linear channels and vod items. API PATH /api/analytics API METHODS ADDING NEW RECORD Adds a new analytics record of either on-demand video usage or linear channel viewing statistics ...Devices API (ENG)
INTRODUCTION Devices API is used to register devices to the server and get device specific information/configurations from the server. API PATH /api/devices It is recommended to use POST request. Latest version: 02 API METHODS REGISTER A DEVICE ...Archive API (ENG)
INTRODUCTION This API is used to manage the content within the Archive, actions like add asset, edit asset and delete asset. All calls must be made by supplying the unique token for your organization. API PATH /api/archive API CALLS ADD ASSET V.2 ...Account Management API (ENG)
INTRODUCTION The API is used to manage Icareus Suite users and organisations. USE CASES Adding sub organization API Calls flow to add sub organization: Create an organization Add User Assign User Assign User role API PATH /delegate/account API ...Applications API (ENG)
INTRODUCTION This API is used to manage Applications. You can create new Applications, edit existing Applications and upload new images for existing Applications. Currently only creation/editing of HbbTV Coupon Applications is supported! API PATH ...