SUPPORTED METHODS:
GET
Parameters | Type | Description |
---|---|---|
key | varchar | API key of a store/company. Can be found on Settings -> Data API page. |
username or email (required) | varchar | Staff member username or email |
password (required) | varchar | Staff member password |
remember (accepted) | enum (1) | 1: remember user |
log_data | varchar |
DOCUMENTATION
GET
Sends user login information. Returns status, data and token.
--
Example Request:
{
"module":"staff.login",
"method":"GET",
"request":{
"key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"username":"[email protected]",
"password":"nicetry"
}
}
Example Response:
{
"status":1,
"data":{
"employee":{
"id":"1",
"eid":"357",
"name":"John Smith",
"username":"jsmith",
"email":"[email protected]",
"group":"5",
"status":"1",
"wage":"780",
"nick_name":"Johnny",
"birth_day":"2",
"birth_month":"8",
"cell_phone":"38166-992-768",
"home_phone":"38131-564-958",
"avatar":{
"small":"http:\/\/cdn.humanity.com\/image1.jpg",
"medium":"http:\/\/cdn.humanity.com\/image2.jpg",
"large":"http:\/\/cdn.humanity.com\/image3.jpg"
},
"address":"Calle 39 No 1540 ",
"city":"Belgrade",
"state":"Serbia",
"zip":"11000",
"notes":"Custom note",
"ical":"http:\/\/www.humanity.com\/efc46ba6c.ics",
"timezone":"-05:00,0",
"timezone_name":"America\/Bogota",
"group_name":"Employee",
"status_name":"Activated",
"schedules":{
"46351":"Office"
}
},
"business":{
"name":"Humanity Inc.",
"address":"Panama City, Panama",
"phone":"888-973-6030",
"fax":"888-973-6030"
}
},
"token":"xxxxxxx"
}