Image editing API

28/01/2010

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.

See also: