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
|
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
|
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
|
Example request:
POST: rt=a/account/account , token=58fb1592f0c59b8dc1d5541aebdff8da
{
"title":"My Account",
"customer_id":"14",
"firstname":"Joe",
"lastname":"Doe",
"email":"test@test.com",
"information":"a\/account\/edit",
"history":"a\/account\/history",
"newsletter":"a\/account\/logout"
} |
Customer Account History
Get customer order history.
Route: a/account/history
Method: POST
|
Example request:
POST: rt=a/account/history , token=58fb1592f0c59b8dc1d5541aebdff8da
{
"orders":[
],
"total_orders":0
} |
Edit Customer Account Details
There are 2 steps to edit and save customer details. First step is to get all required fields and existing data. Second step is to provide data to be updated.
Route: a/account/edit
Method: GET
Get all required and optional fields, values and error messages (if any)
|
Example request:
GET: rt=a/account/edit&token=2f7f30e3efeb0d73744680ac7c0c11e6
{
"fields":{
"firstname":{
"type":"input",
"name":"firstname",
"value":"First Name",
"required":true,
"error":null
},
"lastname":{
"type":"input",
"name":"lastname",
"value":"Last Name",
"required":true,
"error":null
},
"email":{
"type":"input",
"name":"email",
"value":"test@test.com",
"required":true,
"error":null
},
"telephone":{
"type":"input",
"name":"telephone",
"value":"435435435",
"required":true,
"error":null
},
"fax":{
"type":"input",
"name":"fax",
"value":"434543543",
"required":false
},
"newsletter":{
"type":"selectbox",
"name":"newsletter",
"value":"1",
"required":false
}
}
} |
Method: POST
Update customer information
|
Example request:
POST: firstname=First+Name , lastname=Last+Name , email=test@test.com , telephone=435435435 , fax=434543543 , rt=a/account/edit , token=2f7f30e3efeb0d73744680ac7c0c11e6
{
"status": 1,
"text_message":"Success"
} |
Customer Registration
There are 2 steps to register new customer and save customer details. First step is to get all required fields and provided earlier data (in case of error). Second step is to provide data to be validated and saved.
Route: a/account/create
Method: GET
Get all required and optional fields, values and error messages (if any)
|
Example request:
GET: rt=a/account/create&token=2f7f30e3efeb0d73744680ac7c0c11e6
{
"fields":{
"firstname":{
"type":"input",
"name":"firstname",
"value":null,
"required":true,
"error":null
},
"lastname":{
"type":"input",
"name":"lastname",
"value":null,
"required":true,
"error":null
},
"loginname":{
"type":"input",
"name":"loginname",
"value":null,
"required":true,
"error":null
},
"email":{
"type":"input",
"name":"email",
"value":null,
"required":true,
"error":null
},
"telephone":{
"type":"input",
"name":"telephone",
"value":null,
"required":true,
"error":null
},
"fax":{
"type":"input",
"name":"fax",
"value":null,
"required":false
},
"company":{
"type":"input",
"name":"company",
"value":null,
"required":false
},
"address_1":{
"type":"input",
"name":"address_1",
"value":null,
"required":true,
"error":null
},
"address_2":{
"type":"input",
"name":"address_2",
"value":null,
"required":false
},
"city":{
"type":"input",
"name":"city",
"value":null,
"required":true,
"error":null
},
"postcode":{
"type":"input",
"name":"postcode",
"value":null,
"required":false
},
"country_id":{
"type":"selectbox",
"name":"country_id",
"options":{
"FALSE":" --- Please Select --- ",
"1":"Afghanistan",
"2":"Albania",
…
},
"value":"223",
"required":true,
"error":null
},
"zone_id":{
"type":"selectbox",
"name":"zone_id",
"required":true,
"value":null,
"error":null
},
"password":{
"type":"password",
"name":"password",
"value":null,
"required":true,
"error":null
},
"confirm":{
"type":"password",
"name":"confirm",
"value":null,
"required":true,
"error":null
},
"newsletter":{
"type":"radio",
"name":"newsletter",
"value":-1,
"options":{
"1":"Yes",
"0":"No"
}
},
"agree":{
"type":"checkbox",
"name":"agree",
"value":1,
"checked":null
}
},
"text_agree":"I have read and agree to the Privacy Policy<\/b><\/a>"
} |
This will be required only if Require login name setting is ON. |
Method: POST
Validate and save new customer information
|
Example request:
POST: firstname=First+Name , lastname=Last+Name , email=test@test.com , telephone=435435435 , fax=434543543 , … rt=a/account/create , token=2f7f30e3efeb0d73744680ac7c0c11e6
{
"status": 1,
"text_message":"Success"
} |