ShutterPro API Guide - upload direct from your apps

The ShutterPro API is built on a HTTP POST basis and returns all responses in JSON format, this is mainly to utilise bandwidth on mobile devices but JSON is also becoming a widely acceptable cross platform format. To access your unique API you need to append the below resource addresses to this URL and HTTP POST the relevant fields.

The following fields should be submitted with every request otherwise they will fail:

fieldformatcomments
usernamestringEnd users username to the ShutterPro service.
access_tokenstringEnd users security token found on the account summary page.

Please e-mail us at support@shutterpro.co.uk for assistance using the API.


http://upload.shutterpro.co.uk/api/auth/

Provides a method of checking whether a users credentials are valid.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
The users credentials are valid and should be used in other requests.
The users credentials are invalid, you should obtain correct details.

http://upload.shutterpro.co.uk/api/set/

Lists the contents of the selected set, [set_id] must be replaced with the numerical ID which should default to 0 in order to get the contents of the root set. This includes both media and sets with the type identifier.

fieldformatcomments
set_idintegerThe numerical ID of the set which you want to retrieve, use 0 to get the root set with all its child objects.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Users credentials are valid and should be used in other requests.
Users credentials are invalid, you should obtain correct details.

http://upload.shutterpro.co.uk/api/set_create/

Creates a new sub-set of the given parent, there is no limit to the amount of sub-sets.

fieldformatcomments
set_idintegerThe numerical ID of the set which this should be a child of.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Users credentials are valid and should be used in other requests.
Users credentials are invalid, you should obtain correct details.
setintegerThe numerical ID of the newly created set.

http://upload.shutterpro.co.uk/api/set_lock/[set_id]/

Makes the set private so it can not be seen publicly, [set_id] must be replaced with the numerical ID of the set to modify.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Selected set has successfully been made private.
Unable to make the selected set private, try again.

http://upload.shutterpro.co.uk/api/set_unlock/[set_id]/

Makes the set public so it can be seen publicly, [set_id] must be replaced with the numerical ID of the set to modify.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Selected set has successfully been made public.
Unable to make the selected set public, try again.

http://upload.shutterpro.co.uk/api/item/[item_id]/

Retrieves all of the information regarding a media item, [item_id] must be replaced with its numerical ID.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Item has been found and information returned in the object 'item'.
Unable to locate the item, try again.

http://upload.shutterpro.co.uk/api/item_upload/

Uploads a photograph to the selected set.

fieldformatcomments
set_idintegerThe numerical ID of the set which this should be a child of.
photobinary dataFile data in multipart/form-data format.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Media item was uploaded successfully.
There was a problem uploading the file, try again.
messagestringAn informative message of why the upload failed.

http://upload.shutterpro.co.uk/api/search/

Can be used to search the filename or name field of a photograph for all results found on your account.

fieldformatcomments
querystringText string to search ShutterPro for.

Possible responses

fieldvaluescomments
statusstring (successful)
string (failed)
Confirms the query was successful or that there was an error.
resultsarrayContains an array of all media found for the query string.