The shop frontend can be replaced by different shop systems. However, it is important to understand that these shop frontends should have at least the following options for being able to be used as replacement:

• Needs to be able to present different license options (e.g. rental and purchase) for products
• Needs to offer a login function for existing customers (the access to the content is managed by FlickRocket).
• Needs support for SSL to accept payments
• Needs to be able to use SOAP requests to communicate with the FlickRocket Access Backend
• Customers must be forced to specify at least an email and password

The following explains the web services which must be used to integrate the custom shop frontend with the FlickRocket platform.

CheckAccount()The CheckAccount function checks if the account data is valid and can access a certain theme.

bool CheckAccount(string EMail, string Password, int ThemeID, out int ErrorCode)

 <?xml version="1.0" encoding="utf-8" ?><?xml version="1.0" encoding="utf-8" ?>
<Order>
  <TransactionID>001</TransactionID>
  <EMail>Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!;/EMail>
  <Password>password</Password>
  <!-- <PasswordHash> </PasswordHash> -->  <!-- SHA1 Encrypted, only for existing customers -->
  <ThemeID>32</ThemeID>
  <Items>    <!—- Optional: If not included only a customer will be created -->
    <Item>
      <ProjectID>0000-1C80-33B9-7A42</ProjectID>
      <!-- The project to be ordered with this item. Can be found in the web interface. -->
      <LicenseID>16</LicenseID>
      <!-- Identifies the license to be used for the order. Can be found in the web interface. -->
      <Count>1</Count>
    </Item>
    <Item>
      <ProjectID>0000-1B18-685F-0DD8</ProjectID>
      <!-- The project to be ordered with this item. Can be found in the web interface. -->
      <LicenseID>19</LicenseID>
      <!-- Identifies the license to be used for the order. Can be found in the web interface. -->
      <Count>1</Count>
    </Item>
  </Items>
</Order>

<?xml version="1.0" encoding="utf-8" ?><?xml version="1.0" encoding="utf-8" ?>
<Order>
  <TransactionID>001</TransactionID>
  <EMail>    Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!;;/EMail>
    <Password>password</Password>
    <!-- <PasswordHash> </PasswordHash> --> <!-- SHA1 Encrypted -->
    <ThemeID>32</ThemeID>
    <UnlockCodes>
      <UnlockCode>ABCD-ABCD-ABCD-ABCD</UnlockCode>
      <UnlockCode>BCDE-BCDE-BCDE-BCDE</UnlockCode>
    </UnlockCodes>
  </Order>

CheckPreviewExists()

The CheckPreviewExists function is used to check if a preview/trailer exists for the specified project. The function returns true if a preview exists and false if no preview exists.

If a preview exists, it can be played back by navigating (typically in a pop up) to the following link with passing the ProjectID.

http://www.flickrocket.com/services/OnDemandOrder/Preview.aspx?PID=<ProjectID>

bool CheckPreviewExists(string EMail, string Password, string ProjectID)

Sample URL:

http://www.flickrocket.com/services/OnDemandOrder/Preview.aspx?PID=ABCD-ABCD-ABCD-ABCD

ChangeCustomerPassword()

The ChangeCustomerPassword function is used to update the FlickRocket platform with an updated password in case the user changes his password.

In case the original password is not known (e.g. for a “forgotten password” function) where the user is externally verified (e.g. by sending an email with a confirmation link) the function can be used with the magic value “_use_only_after_external_validation_” as original password parameter. However, this works only if the company using the API has created the user or has sold items to the user. THIS MUST NOT BE USED FOR REGULAR PASSWORD CHANGES.

bool ChangeCustomerPassword(string EMail, string Password, string XML, out int ErrorCode)

The XML must be constructed as follows:

Sample XML for regular password change:

ChangeCustomerEmail()

The ChangeCustomerEmail function is used to update the FlickRocket platform with an updated email in case the user changes his email.

bool ChangeCustomerEmail(string EMail, string Password, string XML, out int ErrorCode)

The XML must be constructed as follows:

Sample XML:

PrepareLoginEx()

The PrepareLoginEx function is used to get a unqiue URL for the Access Backend which can be embedded via iframe or to which the user can be redirected after purchase or at login.

bool PrepareLoginEx(string EMail, string Password, string XML, int ThemeID, out int ErrorCode, out string sURL)

The XML must be constructed as follows:

Sample XML:

GetProjects()

The GetProjects function is used to retrieve a list of projects. The function returns true if a valid list of projects is returned.

bool GetProjects (string EMail, string Password, int ThemeID, out List<string> Projects, out int ErrorCode)

GetLicenses()

The GetLicenses function is used to retrieve a list of licenses. The function returns true if a valid list of licenses is returned.

bool GetProjects (string EMail, string Password, out List<stLicense> Licenses, out int ErrorCode)

GetThemes()

The GetThemes function is used to retrieve a list of themes. The function returns true if a valid list of themes is returned.

bool GetThemes (string EMail, string Password, out List<stTheme> Themes, out int ErrorCode)

GetTrailer()

The GetTrailer function is used to retrieve a list of trailers for projects. Please note that trailers are optional and may not exist. If a trailer does not exist, it is not returned as part the stTrailers list. The function returns true if a valid list of trailers is returned.

bool GetTrailer (string EMail, string Password, List<string> ProjectIDs, out List<stTrailer> Trailer, out int ErrorCode)

User data changes syncback

The following describes the process how FlickRocket communicates user information changes (E-Mail/Password changes) to 3rd party shop platforms which are related to the user whose information is updated.

To utilize this functionality, a number of settings has to be done in the related App Settings of the FlickRocket Backend. This is done in the admin interface under Extensions / Mage Apps / <Settings for the App>.

If a change in the email or password occurs, a get request to the UserDataChangeURL with the following parameters is invoked.

The signature used is calculated as SHA-1 hash (hexadecimal output) from the request parameters. The first parameter has to be your secret, followed by the parameters ordered alphabetically by their names. Optional arguments that are used (have value) must be contained in the signature calculation. Optional arguments that are not used must not be contained in the signature calculation.

It is mandatory to convert arguments values into UTF-8 before computing the signature.

Example:

signature = sha1_hex( secret + ":email=" + email + ":new_email=" + new_email + ":new_pw_hash=" + new_pw_hash + ":old_pw_hash=" + old_pw_hash + ":pw_hash_type=" + pw_hash_type)

Example calculation:

Signature calculation using the values above:

signature = sha1_hex(BddJxtUBkDgFB9kj7Zwguxde4gAqha:email=Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!:new_email=Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!:new_pw_hash=a2a1e3f447524d73729d972db3f837c5:MD:old_pw_hash=cc3469055de99a54451507fdf66a3a00:MD:pw_hash_type=4) => a043071d3db1d3bbacee04e1eaf07da0d3ab1d17

The request then is:

https://sample.update.com/update?email=Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!&new_email=Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!&new_pw_hash=a2a1e3f447524d73729d972db3f837c5:MD&old_pw_hash=cc3469055de99a54451507fdf66a3a00:MD&pw_hash_type=4&signature=a043071 d3db1d3bbacee04e1eaf07da0d3ab1d17