The Parameters are the way we tell the application what to do. If you are using the GET method the parameter are received in the URL query string like ”/editor/?param1=this&param2=that”. If you are using the POST method the parameters are a part of the form inputs.

These are the parameters offered by pixlr. Don't forget to URL-encode or escape the parameters if you are using the query string to send us parameters (or use the Javascript library to get that done for you).

To tell the editor where to find the image to edit, set-up the language and other stuff it needs some input from you.

The Input parameters are either sent in the query string like this: http://www.pixlr.com/editor/?image=http://www.pixlr.com/_gfx/example.jpg&loc=en&referer=This_page_man

Or you create a html form and do a post to the editor, we will then get the image and the parameters from the post and create a URL and load it into the editor.

You don't need to set-up anything to specify with method you want to use, we check both the post and the query if there is any input to the editor on start.

To get more information on the different input parameters click on the name.

General

• loc: The language of the service for example “en” or “sv”, default is “en”
• referrer: The name of the referring service for example “Your site name” or “Facebook”.
• exit: The URL to send the visitor if the user click exit/close.

Describe what to open

• image: A URL to the image or the post raw data of the image to open.
• title: The title of the opened image.

How to save back to your server

• method: The way we send the image information, “GET” or “POST”, default is “GET”.
• target: The URL to which we send the image information.
• redirect: If you want a different page to be shown after the save (Not to recommend, use the target page) or “false” if you don't want the user to remain in the application after save.

Remove user choice

• locktarget: Remove the possibility for the user to “save to computer”.
• locktitle: Lock the image title so the user can't change it.
• locktype: Lock the format to save the image in values are jpg, png, bmp, pxd or source.

Optimizing

• credentials: Set to true when a crossdomain.xml is present on your server, this option removes the round-trips we need to make to our server.

The output parameters are the arguments we send to your application when a user saves a image. In what manner we send them depends on what you specify in the input parameter method.

To get more information on the different individual output parameters click on the name.

Output - This is what you get from us

• image: A URL to the image on our server or the raw file post of the saved image.
• type: The image type, “jpg”, “bmp” or “png”.
• state: The state of the image either “new” or “fetched”.
• title: The user preferred file name of the image.