Escolar Documentos
Profissional Documentos
Cultura Documentos
Loyalty Lab, Inc. May, 2007. All contents proprietary and confidential. This document is for information only. No warranties or liability for information in this document are expressed or implied.
Table of Contents
Overview ...................................................................................................... 3 Secure Data Transfer .................................................................................. 3 Summary: How Single Sign On Works............................................................... 4 Single Sign On Process Flow Diagram................................................................ 5 Implementation Details................................................................................... 6 Appendix A: Return codes from SSO authentication ............................................ 7
Page 2
5/11/2007
Overview
Loyalty Lab has created a complete solution that enables multi-channel retailers to attract and retain customers. Loyalty Lab helps you build customer loyalty by deploying a multi-channel retention marketing system that is highly effective, low cost and low-maintenance. Loyalty Lab's System as a Service (SaaS) approach has been designed to minimize integration and deployment effort. Loyalty Labs Single Sign On (SSO) feature provides shoppers with access to loyaltybuilding presentations and offers, such as your ecommerce sites and our seamlessly integrated loyalty sites, without requiring them to log in twice. To implement this feature, your development staff must provide some coding and work with Loyalty Lab's integration team to perform integration testing. The resulting Single Sign On technology provides you with a secure means of giving your shoppers convenient and secure access to loyalty program information. To use SSO, you must implement the following functions: When a shopper logs in, use a Loyalty Lab real time API call to obtain an Authentication Ticket for that shopper. When a shopper opts into the loyalty program, use a Loyalty Lab real time API to create a new shopper record, if one does not already exist. When a shopper clicks on a link to the loyalty program pages hosted by Loyalty Lab, retrieve the Authentication Ticket from the Loyalty Lab API Call and pass it with the URL as a query string. Provide a logout and error handling page. When shoppers need information other than their password, use the Loyalty Lab Real Time API to update the shopper information. The Loyalty Lab Real Time API can also be used to mark a shopper as Inactive.
Page 3
5/11/2007
Page 4
5/11/2007
Match
Client sends request for the customer (email address) to access the loyalty program
Page 5
5/11/2007
Implementation Details
Loyalty Lab API Call This is a REST style call Basic authentication using your REST User is required. (Note: The REST User is created using Loyalty Lab's CRMS application.) This call must be done over SSL If the shopper is not found, then a HTTP 404 response code will be issued, and the HTTP Response Body will contain the XML described below. API Call Syntax HTTP Method: GET from https://api.instorecard.com/xml/shopper/authenticate/?ShopperEMail=<shopper email> Query String Parameters ShopperEMail: Email of the shopper to get the authentication ticket for. Sample Response
<ISCAuthentication xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loyaltylab.com/schema/v2.1/RetailIntegration/"> <ShopperLoginToken>32-64-35-37-79-69-69-30-71-72-2F-57-66-4E-70-35-59-30-73-39-4D44-73-2F-70-70-67-6B-34-30-56-4F-35-46-72-56-61-58-50-53-55-48-73-3D</ShopperLoginToken> </ISCAuthentication>
Variations If a shopper with the supplied email address does not exist, the API call returns a HTTP 404 Not Found with the following response body:
<ISCError xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loyaltylab.com/schema/v2.1/RetailIntegration/"> <ErrorCode>4040</ErrorCode> <Description>The supplied email address does not match a registered customer</Description> </ISCError>
Query String Login Parameters The value of the ShopperLoginToken should then be passed in as the auth_t parameter to the requested Loyalty Pages. Example /../..?auth_t=-64-35-37-79-69-69-30-71-72-2F-57-66-4E-70-35-59-30-73-39-4D-44-73-2F-70-70-67-6B-34-
30-56-4F-35-46-72-56-61-58-50-53-55-48-73-3D
Page 6
5/11/2007
When the rc parameter is contains a negative value, the URL redirect will also contain a ru= query string parameter that will contain the URL that the shopper was trying to reach when the SSO process failed, so that you have an opportunity to correct the problem and retry the request.
Page 7
5/11/2007