Member Register

From KickApps API Reference

Jump to: navigation, search

The Member Register method must be invoked every time a new user registers on an affiliate site. If users try to access the register page from the KickApps domain, they will be redirected to the register page on that the affiliate configured using the SSO Options page under Site Settings in the Affiliate Center. This method will register the user and start a session on KickApps.

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 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 form 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>

The session token and transaction id are valid only for a single user session and are not valid after the user’s session expires on either the affiliate site or on 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="registerNewUser">
<Param paramName="affiliateUserName" paramValue="affiliate_X" />
<Param paramName="affiliateEmail" paramValue="affiliate_X@affiliate.com"/>
<Param paramName="affiliateSiteName" paramValue="AffiliateSite"/>
<Param paramName="userName" paramValue="JohnDoe"/>
<!--Required Field. A minimum of 3 charachters and a maximum of 24 charachters are allowed.Only period".", underscore "_", and Space " " are allowed. -->
<Param paramName="password" paramValue="yeny"/>
<Param paramName="email" paramValue="John.Doe@affiliate.com"/>
<Param paramName="firstName" paramValue="John"/>
<Param paramName="lastName" paramValue="Doe"/>
<Param paramName="birthday" paramValue="1960-01-01"/>
<!-- Date format "yyyy-mm-dd" -->
<Param paramName="gender" paramValue="M"/>
<!-- M/F -->
<Param paramName="clientIP" paramValue="192.258.245.26"/>
<Param paramName="profilePrivacy" paramValue=""/>
<!--Optional Field. Pass 'E' to make members profile public. Pass 'F' to make a members profile private i.e. only his friends can see his profile. Make sure profile privacy is turned on in AC before using this param. -->
<Param paramName="key" paramValue=""/>
<Param paramName="aboutMe" paramValue="my name is totoro!! i am totoro!!!"/>
<Param paramName="answer1" paramValue="this is my first answer!!"/>
<Param paramName="answer2" paramValue="this is my 2nd answer!!"/>
<Param paramName="answer3" paramValue="this is my 3rd answer!!"/>
<Param paramName="answer4" paramValue="this is my 4th answer!!"/>
<Param paramName="answer5" paramValue="this is my 5th answer!!"/>
<Param paramName="answer6" paramValue="this is my 6th answer!!"/>
<Param paramName="answer7" paramValue="this is my 7th answer!!"/>
<Param paramName="answer8" paramValue="this is my 8th answer!!"/>
<Param paramName="answer9" paramValue="this is my 9th answer!!"/>
<Param paramName="answer10" paramValue="this is my 10th answer!!"/>
<Param paramName="genRestApiToken" paramValue="T"/>
</KassoRequest>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<KassoResponse xmlns="http://schemas.kickapps.com/services/soap" responseType="registerNewUser">
<Param paramName="userRequestStatus" paramValue="User registered successfully."/>
<Param paramName="sessionToken" paramValue="A1B2C3D4E5F6"/>
<Param paramName="transactionId" paramValue="1234567890"/>
</KassoResponse>