Shutterfly Open API  |  Go To Shutterfly UE


Description

Take the end user to a Shutterfly User Experience. That is, take the user's Web browser to a workflow on the Shutterfly Web site, usually a workflow to create a personalized Shutterfly product.

The protocol has two variations; your application may use one or the other, at different time:

Single Resource may be viewed as a simplified version of Multiple Resource.

Call Signature

Application ID and call signature are required. Please see Call Signature documentation for more details.

Single Resource

With this variation, your application constructs a 'start URL' like the following:

http://www.shutterfly.com/go2ue/start.sfly?target=xxxx&resourceHref=xxxx

The target and resourceHref are variables. Your app sends the user's Web browser to the constructed URL by means of a link, a redirect, or whatever you prefer. The user will see a workflow on the Shutterfly web site, and interact with it to complete the desired work.

The URL parameters have the following meaning:

target
Description: The desired Shutterfly UE (User Experience).
Required: Yes
Example: OP
Possible values:
                    

    ALBUM
    View a user album.  For example, your app could specify the album to which it had just uploaded some images.


    CALENDAR
    Create a Calendar.  The Shutterfly UE will ask the user to choose a type such as Desk, Wall or Poster.


    CALENDAR-CLASSIC
    Create a Calendar.  The Shutterfly UE will start with Wall calendar already chosen.


    CALENDAR-COLLAGE
    Create a Calendar.  The Shutterfly UE will start with Poster calendar already chosen.


    CARD
    Create a Card.  The Shutterfly UE will ask the user to choose a size/type.


    CARD-4x8
    Create a Card.  The Shutterfly UE will start with 4x8 flat photo card already chosen.


    CARD-5x7
    Create a Card.  The Shutterfly UE will start with 5x7 flat photo card already chosen.


    CARD-GREETING
    Create a Card.  The Shutterfly UE will start with 5x7 folded Greeting cards already chosen.


    CARD-STATIONERY
    Create a Card.  The Shutterfly UE will start with 5x7 flat Stationery cards already chosen.


    COLLAGE_POSTER
    Create a Collage Poster.


    DIGITAL_SCRAPBOOK
    Create a Digital Scrapbook.  The Shutterfly UE will ask the user to choose a size/type.


    DIGITAL_SCRAPBOOK-12x12
    Create a Digital Scrapbook.  The Shutterfly UE will start with 12x12 book already chosen.


    DIGITAL_SCRAPBOOK-8x8
    Create a Digital Scrapbook.  The Shutterfly UE will start with 8x8 book already chosen.


    DIGITAL_SCRAPBOOK-85x11
    Deprecated; this type of book is no longer offered.  The target redirects to DIGITAL_SCRAPBOOK.


    OP
    Order Prints.


    PHOTO_GIFT
    Create a Photo Gift.


    PHOTOBOOK
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will ask the user to choose a size/type.


    PHOTOBOOK-5x7
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will start with 5x7 book already chosen.


    PHOTOBOOK-7x9
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will start with 7x9 book already chosen.


    PHOTOBOOK-8x8
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will start with 8x8 book already chosen.


    PHOTOBOOK-85x11
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will start with 8x11 book already chosen.


    PHOTOBOOK-12x12
    Create a Photo Book, using Shutterfly's Custom Path.  The Shutterfly UE will start with 12x12 book already chosen.


    SHARE
    Post images to a Shutterfly Share site.  The user will be given options to create a new site and to use an existing one.


    SIMPLE-PATH
    Create a Photo Book, using Shutterfly's Simple Path.  The Shutterfly UE will ask the user to choose a size/type.


    STORE
    Start using The Shutterfly Store.


                    
resourceHref
Description: A single Shutterfly resource, such as an album or image URL, which will be passed to the target workflow.
Required: Varies by target workflow
Example: http://ws.shutterfly.com/userid/00001234567/albumid/00005678
Possible values: for target=OP, supply a Shutterfly Open API album URL or image URL

Example (before URL encoding, and all on one line):

http://www.shutterfly.com/go2ue/start.sfly?target=OP
&resource=http://ws.shutterfly.com/userid/00001234567/albumid/00005678

Note: This is a simplified example. You must supply authentication parameters, and a Call Signature as previously mentioned.

Multiple Resource

With this variation, your application can specify multiple resources to the desired Shutterfly UE. For example, you could pass multiple album or image URLs, or a mixture, to the OP (OrderPictures) workflow.

Begin by storing your target and resource parameters in the UE Parameter API. That API will construct the 'start URL' for you, telling you what it is. (See its documentation for details.) Your app sends the user's Web browser to the constructed URL by means of a link, a redirect, or whatever you prefer. The user will see a workflow on the Shutterfly web site, and interact with it to complete the desired work.

How it Ends

The user ends the Shutterfly workflow by closing her browser. There is no callback to your site or application. If you would like the user to continue with your site or application when she is done with Shutterfly, open the Shutterfly workflow in a separate browser window.

© 1999-2014 Shutterfly, Inc. All rights reserved.