Getting Signature Key
|
|
The first step in using our contact grabber API 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
|
Contact Grabber
|
|
The next step after getting the signature key is to creating reference.
|
Reference
|
|
|
Method
|
|
"POST" is supported by StesCodes API and the request should be send to https://stescodes.com/apifull.aspx
|
Function
|
|
To start grabbing contacts, make request with parameters as below.
|
Parameters
|
|
Parameters
|
Description
|
Required?
|
|
1. ServiceName
|
Service Name refers to the mail servers. Inorder to access a service use the below
reference keywords
gmail, yahoo, aol, outlook, icq, pingg, mail.com, aim, plaxo, bigstring, mail2world,
in.com, rediff, freenet, gmx
|
Yes
|
|
2. Signature
|
Formated Signature:
In order to format the signature key, make ajax request to "https://stescodes.com/checkupdate.aspx" page
along with input parameters signature and formaturl. The return result is formated signature which
should be stored in hidden field. The stored formated signature key should be used as
signature key while making request to grab contacts. See sample code for more reference.
|
Yes
|
|
3. username
|
Login email of the particular email server. This field is required for all services
except outlook or csv grabbing requests.
|
Yes/No
|
|
4. filename
|
The http url of the csv file, The request url should be a online csv
file url (eg:"http://stescodes.com/text.csv") and localhost url won't work. This field is
required only for outlook or csv grabbing requests.
|
Yes/No
|
|
5. Password
|
Login password of the particular email server.
|
Yes
|
|
6. Format
|
|
Yes
|
|
|
|
Return Type
|
|
The return type is a of format JSON and XML, below are the example response of JSON and XML formats.
JSON response:
[
{
"name": "stescodes",
"email" : "support@stescodes.com",
"address":"street, city, state, zip, country",
"phone":"xxx xxx xxxx"
}
]
XML response:
<?xml version="1.0" encoding="utf-8"?>
<servicename>
<contacts>
<name>stescodes</name>
<email>support@stescodes.com</email>
<name>street, city, state, zip, country</name>
<phone>xxx xxx xxxx</name>
</contacts>
</servicename>
|
Binding
|
|
Once the contacts are grabbed and received in requested formats, it should be deserialized and
you shall loop through to access the contacts. Binding the data to front end is all customizable.
|
|
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 contacts 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
|
