This is a section of API to provide access to registration, customer login and account access.
It is highly recommended to use HTTPS to access this part of API.
Customer Login or authentication confirmation
This API request needs to be done every time customer request to login to get access to customer account or just to confirm that current authentication is still valid and not expired.
Route: a/account/login
Method: POST
| Parameter | Meaning | Notes |
|---|---|---|
| callback | A JavaScript function to run when the response is received | Optional parameter allows you to specify a JavaScript function to handle query results for pure client-side implementations. Embed the API query in <script> tags. Define the callback function in <script> tags. |
| email or loginname | email address or loginname registered in customer account | Important: If "Require Login Name” is enabled (default), email based login will not work. This param is required for initial login. |
| password | customer’s password | This param is required for initial login |
| token | Access token ID. This token is provided by the system after successful initial authentication | required to confirm established authentication |
| api_key | Unique API key that is set in the control panel | This is optional key that can be set to limit unauthorized (accidental) access to your API |
Example logon request:
POST: rt=a/account/login , loginname=testlogin , password=123456789
{"status":1,"success":"Logged in","token":"58fb1592f0c59b8dc1d5541aebdff8da"}
{"status":0,"error":"Login attempt failed!"}
Example authentication check request:
POST: rt=a/account/login , token=58fb1592f0c59b8dc1d5541aebdff8da
{
"status":1,
"request":"authorized"
}
Account Logout
Simple log out request. Token needs to be disregarded from future use.
Route: a/account/logout
Method: POST
| Parameter | Meaning | Notes |
|---|---|---|
| callback | A JavaScript function to run when the response is received | Optional parameter allows you to specify a JavaScript function to handle query results for pure client-side implementations. Embed the API query in <script> tags. Define the callback function in <script> tags. |
| token | Access token ID. This token is provided by the system after successful initial authentication | required |
| api_key | Unique API key that is set in the control panel | This is optional key that can be set to limit unauthorized (accidental) access to your API |
Example request:
POST: rt=a/account/logout , token=58fb1592f0c59b8dc1d5541aebdff8da
{
"status":1,
"success":"Logged out"
}
Customer Account Details
Get basic customer Details.
Route: a/account/account
Method: POST
| Parameter | Meaning | Notes |
|---|---|---|
| callback | A JavaScript function to run when the response is received | Optional parameter allows you to specify a JavaScript function to handle query results for pure client-side implementations. Embed the API query in <script> tags. Define the callback function in <script> tags. |
| token | Access token ID. This token is provided by the system after successful initial authentication | required |
| api_key | Unique API key that is set in the control panel | This is optional key that can be set to limit unauthorized (accidental) access to your API |