OEMBED API (ENG)

OEMBED API (ENG)

INTRODUCTION

This API is used to query for oEmbed objects for video page URL(s) on Icareus Suite sites.


Note
Suite oEmbed API only supports JSON responses for now

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)

http://suite.icareus.com/api/oembed?url=http://suite.icareus.com/web/tvanywhere-demo/series?assetId=449690&format=json&maxWidth=600&maxHeight=400

Response Status Code: 200

{
 
    "thumbnail_height": 400,
    "thumbnail_url": "http://suite.icareus.com/image/image_gallery?img_id=449727&width=600&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"
 
}

http://suite.icareus.com/api/oembed?url=http://suite.icareus.com/web/tvanywhere-demo/series?assetId=449690

Response Status Code: 200

{
 
    "thumbnail_height": ?720,
    "thumbnail_url": "http://suite.icareus.com/image/image_gallery?img_id=449727",
    "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

{}