Member Sign On
From KickApps API Reference
This method must be invoked every time an existing user signs onto the affiliate site. If users try to access the log in page from the KickApps domain, they will be redirected to the affiliate site’s log in page that was set in the Affiliate Center Site Settings under the SSO Options.
Users are only allowed to be a part of the KickApps session when, before entering the KickApps domain by clicking any of the widgets on the affiliate site, they provide the required session token and transaction id.
KickApps’ response to the Member Sign On and Register request includes the session token and transaction id are which then must dynamically appended to every widget URL on the affiliate site, as in the following example for a JSP page where st and tid are variables that have session token and transaction id values stored from the response.
- Note: If the st (session token) and tid (transaction id) query parameters are not appended to the widget’s URL, the user will not be able to log into the KickApps domain.
<script src="http://kickapps.com/kickapps/service/getFlashEmbedXml.kickAction?b=2944&<%=st%>&<=%tid%>">
</script>
Session tokens and transaction ids are valid only for a single user session and are not valid after the user’s session expires on the either the affiliate site or on the KickApps domain.
To view the validation rule of parameters for this call, see Complete List of KickApps Supported Params
Note: Not all parameters from "Complete List" are supported in this call. Refer to the "Example Request" for the supported parameters instead.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<KassoRequest xmlns="http://schemas.kickapps.com/services/soap" requestName="signInUser">
<Param paramName="affiliateUserName" paramValue="affiliate_X"/>
<Param paramName="affiliateEmail" paramValue="affiliate_X@affiliate.com"/>
<Param paramName="affiliateSiteName" paramValue="AffiliateSite"/>
<Param paramName="userName" paramValue="JohnDoe"/>
<Param paramName="email" paramValue="John.Doe@affiliate.com"/>
<Param paramName="clientIP" paramValue="192.258.245.26"/>
</KassoRequest>
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<KassoResponse xmlns="http://schemas.kickapps.com/services/soap" responseType="signInUser">
<Param paramName="userRequestStatus" paramValue="User Signed In."/>
<Param paramName="sessionToken" paramValue="A1B2C3D4E5F6"/>
<Param paramName="transactionId" paramValue="1234567890"/>
</KassoResponse>