SlideShare API » oEmbed Documentation

Introduction

The oEmbed Specs is the best place to know about oEmbed. SlideShare supports oEmbed specification for making the embeddable media available through its oEmbed API endpoint.

  • Request type : HTTP GET
  • Authorization : none
  • URL : http://www.slideshare.net/api/oembed/2
  • Default response format : xml

Quick example call

http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/haraldf/business-quotes-for-2011&format=json

Query Parameters

  • url (Required) : The URL to retrieve embedding information for
  • maxwidth (optional) : The maximum width of the embed in pixels.
  • maxheight (optional) : The maximum height of the embed in pixels.
  • format (optional) : xml, json, jsonp
  • callback (optional) : Returns jsonp response format. callback is name of the JavaScript function to execute.

Response parameters

  • slideshow_id : Slideshow ID
  • version : The oEmbed version number.
  • type : Type of oEmbed response.
  • title : Title of the embed media.
  • author_name : Author of the embed content.
  • author_url : SlideShare profile page of the author of embed content.
  • provider_name : Provider of the embed content, SlideShare.
  • provider_url : URL of provider.
  • html : The real juice lies here. This is the html embed code, which contains links to embed media.
  • width : Width of the embed media, respects maxheight query parameter
  • height : Height of the embed media, respects maxheight query parameter
  • thumbnail : URL to the thumbnail of embed content.
  • thumbnail_width : Width of thumbnail
  • thumbnail_height : Height of thumbnail
  • total_slides : Number of slides in the slideshow
  • version_no : Version of the slideshow
  • slide_image_baseurl : Base URL of the slideshow images
  • slide_image_baseurl_suffix : Base URL suffix

Error Codes

  • 404 Not Found : If URL is missing or doesn't point to an embeddable resource.
  • 501 Not Implemented : If the format provided is not supported. Should be one of xml, json or jsonp
In case of a jsonp request 200 status code is returned with
{error:true}

as content.

Example

XML Request
http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/
haraldf/business-quotes-for-2011&format=xml
JSON Request
http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/
haraldf/business-quotes-for-2011&format=json
JSONP Request
http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/
haraldf/business-quotes-for-2011&format=jsonp&callback=myFunction
Request with maxwidth specified
http://www.slideshare.net/api/oembed/2?url=http://www.slideshare.net/
haraldf/business-quotes-for-2011&format=json&maxwidth=250

Example XML Response

 
 
   { The oEmbed version number }  
   { Media type }  
   { Embed media height } 
   { Embed media width }  
  { Embed content provider, SlideShare } 
   { URL of the provider } 
   { Thumbnail URL }  
  {Thumbnail height} 
  {Thumbnail width} 
   { Author of embed content }  
   { oEmbed version number }  
   { Author SlideShare homepage }  
   { Embed content title } 
   { ID of the slideshow }
   { Total number of slides in the slideshow }
   { base URL of the slideshow images }
   { base URL suffix }
   { version number of the slideshow }