The Shutterfly Open API is a set of Web resources (URLs) that your application accesses via standard HTTP methods: POST, GET, PUT, DELETE. The Shutterfly Open API attempts to follow an HTTP-REST architectural style.
Data - or in REST terminology, an object's "representation" - is exchanged primarily via XML that follows the Atom Syndication Format. Other formats are used where appropriate: for example, JPEG images are transferred as binary data (although image metadata will still be Atom XML). Also, Shutterfly-specific XML elements (a.k.a. namespaces) are used within Atom XML, where appropriate. Each Shutterfly Open API document lists the XML extensions used by that API.
The Shutterfly Open API currently offers no programming language-specific binding or library. Within Shutterfly, we use Java and Sun Microsystems' ROME library to generate and parse the Atom XML. You may use any programming language you like, as long as the language is capable of making HTTP calls and capable of parsing / generating Atom XML.
To design / develop a Shutterfly Open API application:
Decide what you want your application to do, and which Shutterfly Open APIs let you do it.
For example, an application that uploads images will use the Image Upload API, together with the Authentication API; and perhaps also the User API (POST method) if it needs to register new Shutterfly users.
Choose your programming language.
Again, it can be any language capable of making Web calls and dealing with Atom XML. A language that lets you set HTTP request headers will give you the most flexibility.
Sign up as a Shutterfly member, if you have not done so already.
(This is needed for the step that follows.)
Go to My Applications and do the following:
Choose "Sign Up as a Developer", then "Create New Application", then complete the form and press "OK".
This is how you obtain an ID for your new application, and a corresponding shared secret. Your application will need the ID and secret when it signs its Shutterfly Open API calls.
- Read the Call Signature document.
- Read the documents (parameters, sample XML, etc.) for each Shutterfly Open API you intend to use.
- Choose "Sign Up as a Developer", then "Create New Application", then complete the form and press "OK".
- Start developing!