Image resizing on the client doesn’t always produce good quality images.  E.g. previews or photo thumbs may need to be resized on the fly to fit the page layout. Appending the required image size to the file name instructs ZetaPrints dynamic image generator to serve the requested image in the specified dimensions. Read the rest of this entry »

A user can be logged into your web-to-print portal automatically by passing required parameters in the referral request. This feature is only available if you know user ID and password.

Read the rest of this entry »

This web-to-print API return a list of all web-to-print catalogs per site. It comes useful if you want to import data or synchronise databases.

Read the rest of this entry »

ZetaPrints web-to-print system can be used for template based dynamic imaging. This interface is simplified for preview-only process. An open-source e-cards plugin is hosted under Google Code and utilizes this API. Read the rest of this entry »

This set of API calls provides basic image editing capabilities for web-to-print and dynamic imaging. Only images from user libraries can be edited. The actual hi-res image is not available for downloading or preview.

Common features

All image editing functions require a common set of fields:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)

All image editing functions return a common structure with one or more Image elements inside Images element as illustrated in Web-to-print image library API post.

Rotate image

Use an HTTP POST with an API key, user credentials and an image ID to rotate an image from a library by 90 degrees in either direction.

Format: http://[domain name]/API.aspx?page=api-img-rotate;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)
• Rotation - can only have “r” as a value to rotate clockwise, otherwise rotates anti-clockwise (optional)

Response:

Image details as XML for the specified image with the updated information. The operation failed if image parameters didn’t change.

Restore image

Use an HTTP POST with an API key, user credentials and an image ID to restore the image in the library to the original as it was uploaded. All edits are discarded/

Format: http://[domain name]/API.aspx?page=api-img-restore;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)

Response:

Image details as XML for the specified image with the updated information. The operation failed if image parameters didn’t change.

Edit image description

Use an HTTP POST with an API key, user credentials and an image ID to update image title / description.

Format: http://[domain name]/API.aspx?page=api-img-edit;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)
• Comments - the new image title / description

Response:

Image details as XML for the specified image with the updated information. The operation failed if image parameters didn’t change.

Crop image

Use an HTTP POST with an API key, user credentials and an image ID to crop an image from a user library.

Format: http://[domain name]/API.aspx?page=api-img-crop;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)
• CropX1, CropX2, CropY1, CropY2 - four coordinates within the boundaries of the image thumb (600px x 600px).

There is a lower limit of 10px for X1-X2 and Y1-Y2 distance. It means that the smallest size you can crop to is 10px by 10px.

Response:

Image details as XML for the specified image with the updated information. The operation failed if image parameters didn’t change.

Web-to-print users can upload images into their image libraries to be used in templates. Once an image is uploaded it is validated to be of an accepted type and a small preview is generated. The preview is usually within 600px x 600px. Uploaded images cannot be downloaded.

We offer a set of web-to-print API functions to upload and manipulate the images.

Common response format

All image library and image manipulation functions return a common XML structure:

<Images OwnerID=”03376BB6-913F-4373-B521-6EC172E3612C”>
<Image Folder=”Default” ImageID=”B8B7F7F3-D21D-4309-8FD5-9AA6BB62578A” Created=”2009-10-01T10:25:46.013″ Used=”2009-10-01T09:26:12.013″ Updated=”" MIME=”image/png” Thumb=”21261bc0-6d78-42f8-a975-06206cd7259b.png” ThumbWidth=”215″ ThumbHeight=”150″ ImageWidth=”215″ ImageHeight=”150″ Description=”" Length=”3837″/>
</Images>

There can be up to 50 Image elements inside Images container. Some attributes are explained in the list below:

• OwnerID – ID of the user the image belongs to
• Used - last time the file was used to generate a preview or output files
• Updated - the last time the file was edited
• Thumb - file name in http://[domain name]/photothumbs folder
• Width/Height attributes – dimensions of the original and a resized versions of the image in pixels
• Length - size of the original file in bytes

List of user images

Use an HTTP POST with an API key and user credentials to request last 50 images. The actual library can contain many more images, but only the last used 50 images are returned.

E.g. http://order.example.com/API.aspx?page=api-imgs;ApiKey=79d87451-5a22-4694-a0b4-26ad489d0a87

Format: http://[domain name]/API.aspx?page=api-imgs;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – a GUID generated by a remote system (required)
• Hash – a hash value for user password and server IP (required)
• ImageFolder – a name of the folder to request images from or none for images from all folders (optional)

Response:

The response is an XML document with a list of up to 50 images, if there are any in the user library.

Single image details

Use an HTTP POST with an API key, user credentials and an image ID to request single image details. This function works only of you supply credentials of the image owner.

E.g. http://order.example.com/API.aspx?page=api-img;ApiKey=79d87451-5a22-4694-a0b4-26ad489d0a87

Format: http://[domain name]/API.aspx?page=api-img;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)

Response:

The response is an XML document with at most one Image element

Upload a new image

It is not possible to upload a new image as HTTP PUT or multipart POST operation, but you can instruct ZetaPrints dynamic imaging system to download an image from another server.

For this API to work the web server that hosts the image you want to put in the image library must provide a correct MIME type and the exact length of the file.

This function can be called to download from any web server, not necessary the one the request originates from.

Format: http://[domain name]/API.aspx?page=api-img-new;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• URL – a fully qualified URL where the image is located (required)
• ImageFolder - an arbitrary name for a folder to place an image in (optional)
• Comments - a title of the image or a short description (optional)

Response:

The response is an XML document with a single Image element containing details of the uploaded image.

Delete image

Use an HTTP POST with an API key, user credentials and an image ID to an image from a library. There is no undo or restore for this operation.

Format: http://[domain name]/API.aspx?page=api-img-delete;ApiKey=[your api key]

Parameters:

• ApiKey – see API page in your ZetaPrints account (required)
• UserID – ID of an user who owns this image (required)
• Hash – a hash value for user password and server IP (required)
• ImageID – image id (required)

Response:

An empty image details structure as XML. The operation failed if the structure is not empty.

Printer authentication during web-to-print API calls is controlled by ApiKey parameter which is unique and is not supposed to be shared. User access via API and control of user accounts requires an MD5 hash of the caller’s IP and the user’s password as one of parameters. This post explains how the hash should be calculated. Read the rest of this entry »

Web to print orders API gives direct access to list of orders, their details and all associated resources. One of applications is to download new orders automatically and process the files on the client side, including automatic pre-flight, hot folder routing, data import into MIS and accounting s/w. Read the rest of this entry »

A saved web-to-print order has no output files other than the preview files. An external web-to-print system may request ZetaPrints web-to-print to generate the final order for a given saved order.

Read the rest of this entry »

Web to print orders API gives direct access to list of orders, their details and all associated resources. One of applications is to download new orders automatically and process the files on the client side, including automatic pre-flight, hot folder routing, data import into MIS and accounting s/w. Read the rest of this entry »

This interface gives direct access to all web-to-print order details by OrderID. Read the rest of this entry »

Creating a new web-to-print order via API is a 3-stage process:

• generate previews
• save an order
• generate output files

This API function creates a “saved” web-to-print order for a template using the latest data from the user cache and the previews generated by the web-to-print user earlier. Read the rest of this entry »

A web-to-print order has a status, changed to which are logged and help determine the lifecyle of the order. The status needs to be set to “deleted” for orders to be removed from our web-to-print database.

Read the rest of this entry »

Customer payments can be processed by PayPal directly or by any other custom gateway via API. You can accept payment for your web-to-print and dynamic imaging services via any payments provider as long as you implement a gateway. Read the rest of this entry »

Search for templates may return no or unsatisfactory results. It can be complemented by searching for matching keywords and presenting them as additional web-to-print search options to the user. Read the rest of this entry »

This set of web-to-print API calls allows to do search directly from other websites. Web-to-print templates can be searched by keywords, size and output type. Web-to-print search results come back as an RSS feed with a list of templates, same as for a list of templates returned for a catalog. Read the rest of this entry »

Extended web to print template details can be requested as XML via HTTP GET. You may need this function to show the template in your own web-to-print user interface bypassing ZetaPrints screens altogether. Read the rest of this entry »

Our web to print software allows user access control via API. Access is controlled per web-to-print catalog with GRANT and DENY calls.

Read the rest of this entry »

ZetaPrints web-to-print API allows creating of new users and updating details of existing ones. Read the rest of this entry »

A web to print user can be sent to a ZetaPrints web-to-print portal to complete a design and return order details back to the referring site. This feature allows a range options from referring a user for a one-off design purchase to showing ZetaPrints user interface in an IFRAME. Read the rest of this entry »

Users can be registered via API with a minimal level of detail to enable their access without logging in. Read the rest of this entry »