Documentation

Documentation

Before you can start displaying webthumbs in your web pages, you must create a free account and get your API key.

Once you have your API key, displaying a webthumb on your site is almost as easy as displaying any other image.  In the following examples, we’ll use the imaginary API key ‘abc123′.  You would, of course, replace that with your own API key.

To display a webthumb you embed an image like you normally would, but instead of referencing an image file directly you reference the webthumbs.ca API url.  For example:

<img src="http://webthumbs.ca/api?key=abc123&url=http://example.com" />

By default you will get a JPG image that is size “small” (120 pixels wide). There are other image types and sizes available, plus a variety of other options. For example, if you wanted a PNG version you would add &type=png to the URL in your image tag, like this:

<img src="http://webthumbs.ca/api?key=abc123&url=http://example.com&type=png" />

To get a size “large” image (360×270) you would add &size=l, like this:

<img src="http://webthumbs.ca/api?key=abc123&url=http://example.com&type=png&size=l" />

Other options are simply added to the URL in the same &option=value way.

All Options

Option	Description	Free	Standard	Premium	Enterprise
&key=…	Your API key
&url=…	The URL of the web page to display
&size=t	Return a “tiny” image (60 pixels wide)
&size=s	Return a “small” image (120 pixels wide)
&size=m	Return a “medium” image (240 pixels wide)
&size=l	Return a “large” image (360 pixels wide)
&size=x	Return a “x-large” image (480 pixels wide)
&size=xx	Return a “xx-large” image (640 pixels wide)
&size=xxx	Return a “xxx-large” image (800 pixels wide)
&size=f	Return an image in the original size (up to 1920 pixels wide)
&aspect=1:1	Aspect ratio: 1:1 (square)
&aspect=3:2	Aspect ratio: 3:2 (wide)
&aspect=4:3	Aspect ratio: 4:3 (wide) DEFAULT
&aspect=16:9	Aspect ratio: 16:9 (wide)
&aspect=a	Aspect ratio: north american letter size (tall)
&aspect=a4	Aspect ratio: international letter size (tall)
&aspect=full	Aspect ratio: full page
&type=jpg	Return a JPG image
&type=gif	Return a GIF image
&type=png	Return a PNG image
&type=bmp	Return a BMP image
&refresh=N	Refresh webthumb if the cached version is more than N hours old
&fx=polaroid	Apply the “polaroid” effect to the image
&fx=vignette	Apply the “vignette” effect to the image
&fx=gray	Apply the “grayscale” effect to the image