Getting Signature Key
|
|
The first step in using our Social Login WebService is getting the signature key, signature
key(transaction id) is found once you make purchase and redirected to our website
and also found on the email which you receive from StesCodes after you make purchase.
The transaction id of StesCodes is refered to as signature key.
Inorder to use the trial, you need to generate the key here
http://stescodes.com/trial.aspx. You shall get the key based on the selection
of plan.
|
|
back to top
|
Social Login
|
|
The next step after getting the signature key, is creating reference.
|
Reference
|
| Note: |
You shall download the stescodes_eval.dll for .net 2008 here Download
You shall download the stescodes_eval.dll for .net 2010 here Download
|
|
|
back to top
|
Settings
|
|
Add the below appsettings on your web.config file
<add key="licensekey" value="StesCodes signature key here"/>
<add key="FBApiKey_" value="your facebook api key"/>
<add key="FBSecretKey_" value="your facebook api secret key"/>
<add key="consumerKey_twitter" value="your twitter api key"/>
<add key="consumerSecret_twitter" value="your twitter api secret key"/>
<add key="LiApiKey" value="your linkedin api key" />
<add key="LiSecretKey" value="your linkedin api secret key" />
<add key="GPlusApiKey" value="your googleplus api key"/>
<add key="GPlusSecretKey" value="your googleplus api secret key"/>
<add key="GoogleApiKey" value="your google api key"/>
<add key="GoogleSecretKey" value="your google api secret key"/>
<add key="OrkutApiKey" value="your orkut api key"/>
<add key="OrkutSecretKey" value="your orkut api secret key"/>
<add key="consumerKey_yahoo" value="your yahoo api key"/>
<add key ="consumerSecret_yahoo" value="your yahoo api secret key"/>
<add key="consumerKey_myspace" value="your myspace api key"/>
<add key ="consumerSecret_myspace" value="your myspace api secret key"/>
<add key="wll_appid" value="your live api key"/>
<add key="wll_secret" value="your live api secret key"/>
<add key="consumerKey_foursquare" value="your foursquare api key"/>
<add key ="consumerSecret_foursquare" value="your foursquare api secret key"/>
<add key="AOL_developerkey" value="your aol api key"/>
<add key="soundcloudApiKey" value="your soundcloud api key"/>
<add key="soundcloudSecretKey" value="your soundcloud api secret key"/>
<add key="MeetupApiKey" value="your meetup api key"/>
<add key="MeetupSecretKey" value="your meetup api secret key"/>
<add key="GithubApiKey" value="your github api key"/>
<add key="GithubSecretKey" value="your github api secret key"/>
<add key="lastfmApiKey" value="your lastfm api key"/>
<add key="lastfmSecretKey" value="your lastfm api secret key"/>
<add key="upcommingApiKey" value="your upcoming api key"/>
<add key="consumerKey_flickr" value="your flickr api key"/>
<add key ="consumerSecret_flickr" value="your flickr api secret key"/>
|
|
back to top
|
Login/Register
|
|
To start grabbing user information, you have to make request to three functions
- getAuthenticationUrl
- getAccessToken
- getLoginUserInfo
To configure API keys, click here
How to configure API keys.
|
|
Function for getAuthenticationUrl
|
|
GetAuthenticationUrl(ServiceName, ConsumerKey, ConsumerSecret, CallBackUrl);
|
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. ServiceName
|
Service Name refers to the social networks. Inorder to access a service use the below
reference keywords
facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
2. ConsumerKey
|
Consumer key(API Key) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
3.ConsumerSecret
|
Consumer Secret(APi Secret) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
4. callbackurl
|
CallbackURL is the return url which is used, once the user is redirected to authorize, he/she will be redirected to the callbackurl
(note: sometimes you might get error with callbackurl between www.xx.com and xx.com, so carefull with www)
|
Yes
|
|
|
Return type
|
The return type is collection.
- authurl
- Token
- TokenSecret
- TokenVerifier
- UID
- error
|
|
|
|
Function for getAccessToken
|
|
getAccessToken(ServiceName,Token, TokenSecret, TokenVerifier, CallBackUrl, ConsumerKey, ConsumerSecret,signature);
|
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. ServiceName
|
Service Name refers to the social networks. Inorder to access a service use the below
reference keywords
facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
2. Token
|
Token which you received through callback url after user redirection from authorization page.
|
Yes
|
|
3. TokenSecret
|
TokenSecret which you receive from "GetAuthenticationUrl" as return parameters.
(note:for hotmail, msn and msnmessenger pass this parameter as empty string)
|
Yes/No
|
|
4. TokenVerifier
|
TokenVerifier which you received through callback url after user redirection from authorization page.
(note:for gmail, hotmail, msn and msnmessenger pass this parameter as empty string)
|
Yes/No
|
|
5. CallBackUrl
|
CallbackURL is the return url which is used, once the user is redirected to authorize, he/she will be redirected to the callbackurl
(note: sometimes you might get error with callbackurl between www.xx.com and xx.com, so carefull with www)
|
Yes
|
|
6. ConsumerKey
|
Consumer key(API Key) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
7.ConsumerSecret
|
Consumer Secret(APi Secret) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
8. Signature
|
Formated Signature:
In order to format the signature key, make reference of "processor" class and then
pass your signature key along with the HttpContext object associated with the page
as input parameter to "getSecretKey", which is a function of "processor" class.
The signature must be formatted before making a request.
|
Yes
|
|
|
Return type
|
The return type is collection.
- authurl
- Token
- TokenSecret
- TokenVerifier
- UID
- error
|
|
|
|
Function for getLoginUserInfo
|
|
getLoginUserInfo(servicename, Token, TokenSecret, TokenVerifier, Uid, ConsumerKey, ConsumerSecret, OID_Data, Signature);
|
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. ServiceName
|
Service Name refers to the social networks. Inorder to access a service use the below
reference keywords
facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
2. Token
|
Token which you received from "GetAccessToken" as return parameter.
|
Yes
|
|
3. TokenSecret
|
TokenSecret which you receive from "GetAccessToken" as return parameters.
|
Yes/No
|
|
4. TokenVerifier
|
TokenVerifier which you receive from "GetAccessToken" as return parameters.
|
Yes/No
|
|
5. Uid
|
User id which you receive from "GetAccessToken" as return parameters.
|
Yes/No
|
|
6. ConsumerKey
|
Consumer key(API Key) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
7.ConsumerSecret
|
Consumer Secret(APi Secret) which you received after registering you application on facebook, gplus, twitter, linkedin, google, yahoo, aol, live, myspace, flickr, foursquare, soundcloud,
openid, meetup, github, lastfm, upcoming and orkut.
|
Yes
|
|
8. OID_Data
|
OpenIDData which you receive from "getOpenIdData" as return parameters. Pass empty object for service except AOL and OpenID.
|
Yes/No
|
|
9. Signature
|
Formated Signature:
In order to format the signature key, make reference of "processor" class and then
pass your signature key along with the HttpContext object associated with the page
as input parameter to "getSecretKey", which is a function of "processor" class.
The signature must be formatted before making a request.
|
Yes
|
|
|
Return Types
|
The return type is collection.
- aboutme
- id
- displayName
- firstName
- lastName
- email
- profileUrl
- photo
- location
- phone
- gender
- relationship
- dob
- error
|
|
|
|
Function for getOpenIdAuth
|
|
getOpenIdAuth(serviceName, userName, CallbackUrl, Domain, signature);
|
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. serviceName
|
Service Name refers to the openid provider name. Inorder to access a service use the below
reference keywords
|
Yes
|
|
2. userName
|
Open ID user name.
|
Yes
|
|
3. CallbackUrl
|
CallbackURL is the return url which is used, once the user is redirected to authorize, he/she will be redirected to the callbackurl
(note: sometimes you might get error with callbackurl between www.xx.com and xx.com, so carefull with www)
|
Yes
|
|
4. Domain
|
Your domain url
|
Yes
|
|
5. Signature
|
Formated Signature:
In order to format the signature key, make reference of "processor" class and then
pass your signature key along with the HttpContext object associated with the page
as input parameter to "getSecretKey", which is a function of "processor" class.
The signature must be formatted before making a request.
|
Yes
|
|
|
Return type
|
The return type is collection.
- authurl
- Token
- TokenSecret
- TokenVerifier
- UID
- error
|
|
|
|
Function for getOpenIdData
|
|
getOpenIdData(QueryValue, userName, signature);
|
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. QueryValue
|
All the querystringvalue ex: token=XXXXXX&openid=YYYYYY&url=ZZZZZ
|
Yes
|
|
2. userName
|
Open ID user name.
|
Yes
|
|
3. Signature
|
Formated Signature:
In order to format the signature key, make reference of "processor" class and then
pass your signature key along with the HttpContext object associated with the page
as input parameter to "getSecretKey", which is a function of "processor" class.
The signature must be formatted before making a request.
|
Yes
|
|
|
Return type
|
The return type is collection.
- aboutme
- id
- displayName
- firstName
- lastName
- email
- profileUrl
- photo
- location
- phone
- gender
- relationship
- dob
- error
|
|
|
Debugging
|
|
Debugging Windows Live:
Debugging for Hotmail, MSN and msnmessenger is hard when compared to other services because in OAuth method, for the
three services, you receive the token in post data other than in querystring. So follow the below steps to debug in local
- Upload the auth.aspx page to your server.
- Do the below five steps when the user is redirected after authentication.
- Get the post data and construct as a url with querystring parameter(for ex: token=xxx&tokensecret=yyyy as
http://youdomain.com/auth.aspx?token=xxx&tokensecret=yyyy)
- After constructing the parameter change the constructed url to localhost url(for ex: http://youdomain.com/auth.aspx?token=xxx&tokensecret=yyyy to
http://localhost:2345/yourproject/auth.aspx?token=xxx&tokensecret=yyyy
- Redirect to the localhost url(for ex: Response.Redirect(http://localhost:2345/yourproject/auth.aspx?token=xxx&tokensecret=yyyy);)
- Now you will get the token in localhost for debugging.
- Remove the redirection part after you done with your debugging.
|
|
back to top
|
Binding
|
|
Once the informations are grabbed and received in collection object, you can bind the data to front end for registration process
or check with the database for existance of the user and if exist login.
|
|
back to top
|
Error Handling
|
|
There are few error messages you need to taken care on your end
|
Error Message
|
|
Error
|
Description
|
|
1. Invalid domain
|
The license(Signature Key) is not registered for this domain. You shall change/edit
your domain here http://stescodes.com/sourceupdate.aspx
|
|
2. Invalid key
|
The Signature Key is invalid.
|
|
3. Invalid username & password
|
The username or password is invalid.
|
|
4. Please try again
|
Please try again one more time.
|
|
5. Please login to http://www.gmail.com and then try again
|
If the user account is not used for long time Gmail will ask for CAPTCHA authentication,
so user have to login to his account and then try importing.
|
|
6. Missing input
|
Missing the input parameter
|
|
7. This service not available on your plan
|
The service you are requesting to grab info are not available on your purchased
plan.
|
|
|
back to top
|
Change Domain
|
|
If you get the domain is invalid and you purchased license for that domain, then
you shall follow the below steps to update your domain.
|
Edit/Change Domain
|
To edit or change your domain
- Login to http://stescodes.com/sourceupdate.aspx
- You shall login using email and password which you received in email during purchase
or you shall use the StesCodes transaction id
- Once you login, click the edit link near website
- Enter the domain details
- Click "proceed" to save.
|
|
back to top
|