kwout | API

kwout \| API	my kwout \| history \| add-on \| extension \| Help \| News

API

Don't you wish to integrate "kwout" with your blog or web site, so that readers can easily quote your contents (news, goods, etc.)? Now you can do it using our APIs.

kwout this! button

You can put a button on your web page, which allows readers to quote the web page via kwout.

Sample

We provide three types of button.

Type A	A button that allows readers to grab a screenshot of the entire web page, select an area of the screenshot, and actually quote it. Please click the left "k" button to check how this type of button works. You will get a screenshot of this page.
Type B	A button that allows readers to quote an area you specified by the XPath of the area of the web page. Please click the left "k" button to check how this type of button works. You will get the "Sample" section of this page directly.
Type C	Type C is called "kwout everywhere". It's using Type B inside.

How to integrate "Type A"

Please copy the following code and paste it to your blog or web site.

<a href="javascript:window.location='http://kwout.com/grab?address='+encodeURIComponent(window.location.href);" title="kwout this!"><img src="http://kwout.com/images/api.gif" alt="kwout this!" title="kwout this!" height="16" width="19" style="border: none; vertical-align: middle;" /></a>

How to integrate "Type B"

Please make a GET request with the following parameters, on "http://kwout.com/grab?".

address	web page address (URL needs to be encoded)
xpath	XPath of the area of the web page
preset	1: response (the cut out image) will be cached permanently (default) 0: response (the cut out image) will be cached for 5 minutes

Here is a sample request.

http://kwout.com/grab?address=http%3A%2F%2Fkwout.com%2Fhelp%2Fapi&xpath=id(%22sample%22)

Referer API

By using Referer API, you can get a list of web pages that quote your web page via kwout. This API is useful when you wish to show the list of web pages on your web page.

Referer API returns to the list of web pages in a JSON/JSONP format. Please make a GET request with the following parameters, on "http://kwout.com/api/get_referer?".

address	web page address (URL needs to be encoded)
blog	1: response will be filtered only to a list of permalinks of blog articles 0: response will not be filtered at all, and will include all the referer (default)
summary	maximum length of summary, which will be extracted from a blog article (default is 255)
callback	callback function name (JSONP)

Here is a sample request.

http://kwout.com/api/get_referer?address=http%3A%2F%2Fkwout.com%2F&blog=1

For Enterprise Use

For enterprise use, we can customize "kwout" as per your needs. ITmedia Inc., an online media company serving the Japanese IT market, for instance, has integrated "kwout" with their web sites like this. If you are interested in enterprise use, please feel free to contact us at support at heartrails dot com.