Qwiki

Collections

The Qwiki Embed API allows third party applications to easily embed a series of Qwikis. It is possible to embed a curated collection of Qwikis such as the "Qwiki of the Day" or supply a search query and embed the returned results. To get started, you can either use the embed code from one of the samples to the right or follow the documentation below.

Embed Code

Below is the default embed code to syndicate the "Qwiki of the Day" collection:

<div id="qotd"><p style="margin-top:5px"><a href="http://www.qwiki.com/" target="_blank" title="Experience more on qwiki.com" style="text-decoration:none;color: #999;font-family:'trebuchet ms';font-size:13px">Experience more on <strong style="color: #000;">Qwiki.com »</strong></a></p></div> <script src="http://embed-api.qwiki.com/static/js/jquery-1.4.2.min.js" ></script> <script src="http://embed-api.qwiki.com/static/js/v1/api.js" ></script> <script> (function(config) { config.collection = "qotd"; config.container = "#qotd"; config.width = 356; QwikiContainer.build(config); })({}); </script>

Embed Options

Specify the container to send the embedded element:

config.container = "#qotd";

Specify the embedded container width (valid range: 150-356):

config.width = 356;

Specify which collection of Qwikis to use:

config.collection = "qotd"; This will produce the most recent set of Qwikis from the Qwiki of the Day collection.

Instead of a collection, a search term can be specified:

config.query = "new york city";

The number of Qwikis to retrieve (max 20):

config.count = 6;

Configure the layout:

config.layout = "series"; Can also be "grid" to show a four Qwikis in a tabular layout per page.

Data

The Qwiki Data API lets a user query for Qwiki's corpus of over 3 million topics. The results are returned in JSON or JSONP format.

Data Options

Lists:

URL: http://embed-api.qwiki.com/api/v1/list.json

Parameters:

collection The collection to get results from, currently accepts "qotd".
count The number of items to reurn. Defaults to 6.
callback An optional callback function; if specified the results will be returned wrapped in this function in JSONP format.

Search:

URL: http://embed-api.qwiki.com/api/v1/search.json

Parameters:
q Required. The query to execute on the server.
count The number of items to reurn. Defaults to 6.
callback An optional callback function; if specified the results will be returned wrapped in this function in JSONP format.

Return Format

The return format is either JSON or JSONP. Below is a JSON example; if JSONP is specified the response will be wrapped in the supplied callback function.

[{ "title": "San Francisco", "thumbnail": "http://50x50-1.ikiwq.com/1ChbKFG9Fv1HetpZ8fBmvd.jpg", "snippet": "San Francisco is a city and county in California.", "embed_url": "http://www.qwiki.com/embed/San_Francisco", "publish_date": "Mar 15", "date": "2011-03-15"}, ... ]

Example Integrations

"Astonishing" - Real Qwiki App Reviews. Get Qwiki On Your iPad.

Qwiki: iPad Demo Video

Qwiki Embed API

Collections

Embed Code

Embed Options

Data

Data Options

Return Format

Example Integrations

Qwiki of the Day Series

A search query, in grid layout

A narrow column

Please Check Your Email

Thank you!