API Help
From Clipta
Contents |
Clipta XML API Documentation
Clipta XML API is the programmatic interface to the Clipta Video Search Engine. Using the API, developers can access the data contained in the Clipta videos index to build a variety custom applications that feature video search functionality.
To use the API please register here to receive the API key. Once you receive the API key you will have access to the data in Cliptas index and can now retrieve search results and display the output on your website.
The API provides a REST style interface for accessing the Clipta videos index. With this approach, queries consist of an URL string with a set of specified parameters. Since the entire query is contained in a simple URL expression, queries can be submitted from the browser address bar, the command line, or inside the code of any custom application that can submit an HTTP GET request to a specified URL.
Examples
Check out how Clipta API is used on the Examples Page.
Request
The request is passed with following fields:
query - The string which contains search terms.
site - Site name with which you have registered.
key - API Key which you received when registered.
offset - Starting number from which to show results.
limit - Number of results to return. (Value from 0 to 100)
Sample request URL: http://clipta.com/api?method=search&query=madonna&site=test2&api_key=595a7a9aed18d67ba4d17dfdda7cdf28&offset=0&limit=20
This request will bring back first 20 results of videos for 'madonna'.
Response
XML response will be returned upon submission of the request.
<SearchResults> - Container for all of the video records for the this query.
<total> - Total number of videos found for this query.
<video> - Container for all the fields for an individual video result.
<title> - Title of the video.
<description> - Description provided for the video. (Note: not all videos have description)
<url> - URL which links directly to the page of the original content provider where video is played.
<thumbnailUrl> - URL of the thumbnail image. (Note: different content providers have different sizes for thumbnails)
<embedCode>- HTML tag which, when embedded on a page, will play the video.
<uploadDate> - Date when the video was uploaded by a user or content provider.
<cliptaLink> - URL which links to Clipta Play Page for the video, where users can interact and discover more video content.
Sample Response
<SearchResults>
<total>84542</total>
<video>
<title>Madonna and Justin Timberlake 4 Minutes Mash Up</title>
<description>
Nina B blew it up with a mash up of 50 Cent’s “I Get Money” and Madonna’s “Music,” and now she’s at it again...
</description>
<url>
http://www.dailymotion.com/video/x59f5k_madonna-and-justin-timberlake-4-min
</url>
<thumbnailUrl>
http://ak.static.dailymotion.com/dyn/preview/160x120/8837624.jpg
</thumbnailUrl>
<embedCode>
<div><object width="640" height="380"><param name="movie" value="http://www.dailymotion.com/swf/x59f5k_madonna....
</embedCode>
<uploadDate>2009-04-29 15:16:18</uploadDate>
<cliptaLink>
http://clipta.com/Madonna_and_Justin_Timberlake_4_Minutes_Mash_Up__v231858302
</cliptaLink>
</video>
</SearchResults>
