webresizer home

Web Resizer - API

Documentation

Web Resizer photo editor API

Follow the instructions below to have webresizer running on your website in around 5 minutes.

To use webresizer in your website:

  1. Sign up for a free API key
  2. Copy the below javascript into the position on the page where you would like to embed webresizer.
<script type="text/javascript">
webresizer_apikey = 'your API key here';
webresizer_language = 'en';
</script>
<script type="text/javascript"
src="http://api.webresizer.com/ext/js/webresizer_api.js">
</script>

That's it! Webresizer will now appear embedded in your page.

Choose optional API parameters to suit your needs ...

API Parameters

webresizer_apikey The API key you recieved when you registered to use webresizer.
  valid values valid API key for your domain
  default value Must be specified
webresizer_iframe_height The minimum iframe height.

The iframe will automatically change height to cater for the size of the uploaded image if webresizer_autosize="yes"

  valid values 900 [min] to 3000 [max]
  default value 900
webresizer_iframe_width The minimum iframe width.

The iframe will automatically change width to cater for the size of the uploaded image if webresizer_autosize="yes"

  valid values 520 [min] to 3000 [max]
  default value 520
webresizer_iframe_autosize 'yes' allows the iframe to automatically resize to cater for the current size of the image.

note: page designs will need to allow for autoresizing of the embedded iframe

  valid values yes, no
  default value yes
webresizer_image_url URL of the image to initially load into webresizer.

use this value to replace the duck

  valid values valid image URL
  default value ducky.jpg
webresizer_default_image_size Automatically resize images to this width on inital upload.
  valid values 5 [min] to 800 [max]
  default value 200
webresizer_allow_uploads Allow images to be uploaded using webresizer.
  valid values yes, no
  default value yes
webresizer_allow_downloads Display the download link on images.

see parameter webresizer_is_sample_image

  valid values yes, no
  default value yes
webresizer_single_image Display the optimised image only.
  valid values yes, no
  default value no
webresizer_single_line The image dimensions shown under the photos will appear on a single line.
  valid values yes, no
  default value no
webresizer_uplink_text Text to display as the link on webresizer that allows users to transfer images to your site.

e.g. 'Save image to my gallery'

see parameter webresizer_is_sample_image

  valid values string
  default value empty string
webresizer_uplink_url URL to call to transfer the image to your site. (i.e. the location of your callback routine)

details of the optimized image are made available to your callback routine as GET parameters

  valid values valid URL
  default value empty string
webresizer_is_sample_image The image being loaded into webresizer is only a sample image or is to be available for saving.

e.g. 'yes' will hide the save image link under this photo, 'no' if you want the 'uplink_text' or 'download link' to appear under this photo.

  valid values yes, no
  default value yes
webresizer_debug_mode Turn on debugging - useful during initial setup.
  valid values yes, no
  default value yes
webresizer_language The language to display the user interface in.

e.g. select 'fr' and all webresizer controls will be in French

  valid values pt, nl, it, fr, es, en, dk

------------------

pt = Portuguese

nl = Dutch

it = Italian

fr = French

es = Spanish

en = English

dk = Danish

  default value en

webresizer_apikey is mandatory. All other parameters are optional.

We hope you enjoy using Web Resizer!

For help with configuration options or to request a new feature contact us here.

Please note each API key is unique and authenticated for use on your domain only. The API will not work if you attempt to use someone elses API key or cut and paste the demo API key ... you'll need to sign up first!

Copyright 2008 SiteSpace Australia