1. 登录
用户登录。
请求方式：POST
请求地址：/bospersonnelservice/{appKey}/users/login
1.1. 请求参数：
Headers：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
PathParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| appKey | string | w8486e2a067e4bdab7630546ad01751a | 是 | 代表应用的 key |
SearchParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
Body(form-data)
{
"name": "15702097950",
"password": "sj15702097950",
"isRemember":false,
"language":"en"//界面中英文类别，目前只支持参数cn和en
}
1.2. 参数说明：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| name | string | admin | 是 | 用户名/手机号 |
| password | string | admin | 是 | 密码 |
| isRemember | Boolean | true | 否 | 是否记住 |
1.3. 正确返回：
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiNGIwMmNkMmJkMDJjNDM0MWE0NWYyYzI3MDYwMWI5YTgiLCJ1c2VyTmFtZSI6InNvbmd5b3VsaSIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6ImJvcyIsImFwcE5hbWUiOiJib3MiLCJsb2dpblRpbWUiOiIxNTMzNTIwMjEwMjk4IiwiZXhwIjowfQ.wlghNUjzSlaMnK88NiPGKiOtNnoTxY_iNZdJITugBsI",
"expires": "1533534610298",
"isFirstLogin":true,
"user": {
"id": "4b02cd2bd02c4341a45f2c270601b9a8",
"name": "Tom",
"fullName": "Tom",
"telephone": "18938865427",
"active": "1",
"guser": "4b02cd2bd02c4341a45f2c270601b9a8",
"gtime": "1533132726914",
"userType": "0",
"company": null,
"email": "Tom@163.com",
"contact": null,
"lastLoginTime": "1533539634950",
"registerTime": null,
"guid": null,
"myApps": null,
"appCount": null,
"language":"en"
}
}
}
1.4. 状态码：
| 状态码 | code | message | data | 原因 |
|---|---|---|---|---|
| 400 | MISSING_REQUIRED_PARAMETERS | 账号/密码不能为空 | NULL | 如果name、password为空 |
| 400 | USER_LOCK | 账号已被锁定 | NULL | 如果用户被锁定 |
| 400 | USER_NO_EXIST | 用户不存在 | NULL | 如果用户不存在 |
| 400 | LOGIN_ERROR | 密码错误，您还可以尝试x次 | NULL | 如果密码错误，并且还没被锁定 |
| 400 | LOGIN_ERROR | 密码错误3次，请找回密码或20分钟后重试 | NULL | 如果密码错误，并且被锁定 |
| 400 | USER_NOT_ACTIVE | 账号已冻结 | NULL | 如果用户被锁定 |
| 400 | APP_NO_EXIST_ERROR | 应用不存在 | NULL | 如果appKey不为空并且对应的应用无法找到 |
| 400 | USER_APP_EXIST_ERROR | 用户没有关联应用 | NULL | 如果用户没有关联应用，并且应用不是开放性的 |
1.5. 注意事项：
暂无注意事项
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bospersonnelservice/w8486e2a067e4bdab7630546ad01751a/users/login
Headers
null
Body(form-data)
{
"name": "15702097950",
"password": "xxxxxx"
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6Inc4NDg2ZTJhMDY3ZTRiZGFiNzYzMDU0NmFkMDE3NTFhIiwiYXBwTmFtZSI6InRlc3QxMTIzMyIsImFwcERiIjoidzg0ODZlMmEwNjdlNGJkYWI3NjMwNTQ2YWQwMTc1MWEiLCJsb2dpblRpbWUiOiIxNTk3OTkzMzg3ODMzIiwiZXhwIjowfQ.YNP1pacX8FEk6qwn0ECisKE-d9TMkho45uceuQobO_s",
"expires": "1598014987833",
"user": {
"id": "1527ffadaf8a4f4abae985c67bbd496d",
"name": "zhangsan",
"fullName": "张三111-test",
"telephone": "18379709411",
"active": "1",
"guser": "1527ffadaf8a4f4abae985c67bbd496d",
"gtime": "1597125600440",
"userType": "1",
"company": "盈嘉内部员工123",
"email": "",
"contact": null,
"lastLoginTime": "1597993387833",
"registerTime": "1562145757298",
"guid": null,
"myApps": null,
"appCount": null,
"guserType": null,
"bosUserType": "0",
"appNumberLimit": 30,
"userModelStorageLimit": 10.0,
"subscriptionStatus": "2",
"subscriptionStartTime": "1588176000000",
"subscriptionExpireTime": "1619712000000",
"alreadyUsedAppCount": 9,
"alreadyUserModelStorage": 3.533,
"resetPassword": "no",
"secretAnswer": null
},
"modelDb": [
"o5ef1e5649cd47fca423ad1bb7669a03"
],
"firstLogin": false
}
}