Description
Authenticates the token generated by the Generate Token method and returns the Customer details, if authenticated.
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/customers/authenticate-token.json?auth-userid=0&api-key=key&token=authenticationtoken
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| token | String | Required | Authentication Token |
Response
Returns a hash map containing the below details, if the token is authenticated:
-
Customer Id (customerid)
-
Customer Username (username)
-
Your Reseller Id (resellerid)
-
Reseller Id of your Parent Reseller (parentid)
-
Name (name)
-
Company (company)
-
Email Address (useremail)
-
Telephone Number Country Code (telnocc)
-
Telephone Number (telno)
-
First line of address of the Customer (address1)
-
Second line of address of the Customer (address2)
-
Third line of address of the Customer (address3)
-
City (city)
-
State (state)
-
Country Code (country)
-
ZIP Code (zip)
-
Personal Identification Number (pin)
-
Creation Date (creationdt)
-
Current Status (customerstatus)
-
Sales Contact Name and Email Id (salesrepresentative)
-
Language Preference for the Control Panel and Emails (langpref)
-
Total Receipts (totalreceipts)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.