1. 注册
用户注册。
请求方式:POST
请求地址:/bospersonnelservice/{appKey}/users/regist
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | w8486e2a067e4bdab7630546ad01751a | 是 | 代表应用的 key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
Body:
application/json:
{
"name": "xxx",
"password": "xxx",
"fullName": "xxx",
"email": "xxx@xx.com",
"telephone": "xxx",
"validateCode": "xxx",
"secretAnswer ": [
{
"question1": "aa",
"answer1": "aa"
}
],
"xxx": "xxx",
"language":"en"//界面中英文类别,目前只支持参数cn和en
}
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
name | string | NULL | 是 | 账号 |
password | string | NULL | 是 | 密码 |
fullName | string | NULL | 是 | 姓名 |
string | NULL | 否 | 邮箱,可选 | |
telephone | string | NULL | 是 | 手机号 |
validateCode | string | NULL | 是 | 短信验证码 |
secretAnswer | object | NULL | 否 | 安全问题 |
1.3. 正确返回:
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiNGIwMmNkMmJkMDJjNDM0MWE0NWYyYzI3MDYwMWI5YTgiLCJ1c2VyTmFtZSI6InNvbmd5b3VsaSIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6ImJvcyIsImFwcE5hbWUiOiJib3MiLCJsb2dpblRpbWUiOiIxNTMzNTIwMjEwMjk4IiwiZXhwIjowfQ.wlghNUjzSlaMnK88NiPGKiOtNnoTxY_iNZdJITugBsI",
"expires": "1533534610298",
"user": {
"id": "4b02cd2bd02c4341a45f2c270601b9a8",
"name": "Tom",
"fullName": "Tom",
"telephone": "18938887797",
"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 | PARAMETER_VALID_ERROR | xxx不能为空 | NULL | 如果name、password、telephone、validateCode为空 |
400 | TELEPHONE_FORMAT_ERROR | 手机号格式错误 | NULL | 如果telephone不是手机号格式, |
400 | TELEPHONE_OCCUPIED | 手机号已被占用 | NULL | 如果telephone已被占用 |
400 | NAME_OCCUPIED | 用户名已被占用 | NULL | 如果name已被占用 |
400 | EMAIL_OCCUPIED | 邮箱已被占用 | NULL | 如果输入email,并且email已被占用 |
400 | EMAIL _FORMAT_ERROR | 邮箱格式错误 | NULL | 如果输入email,并且email不是邮箱格式 |
400 | CAPTCHA_INPUT_ERROR | 验证码错误,请重新输入 | NULL | 如果验证码校验不通过 |
1.5. 注意事项:
暂无注意事项
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bospersonnelservice/w8486e2a067e4bdab7630546ad01751a/users/regist
Headers
null
Body(application/json)
{
"name": "zs123456",
"password": "yyyyyyy",
"fullName": "张三",
"email": "123456789@qq.com",
"telephone": "12345678910",
"validateCode": "7770"
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiOTRhYzJlZDViODA5NGFmMTlmZTM1NzM5NTA2OGQ0YjciLCJ1c2VyTmFtZSI6InJqajEyMzQ1NiIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6Inc4NDg2ZTJhMDY3ZTRiZGFiNzYzMDU0NmFkMDE3NTFhIiwiYXBwRGIiOiJ3ODQ4NmUyYTA2N2U0YmRhYjc2MzA1NDZhZDAxNzUxYSIsImxvZ2luVGltZSI6IjE1OTc5OTQ1MzU2ODIiLCJleHAiOjB9.Np-1im5BTrts6NDfl6_7CHyRtBE_ZsCjgLhYCBUz6ds",
"expires": "1598016135682",
"modelDb": [
"o5ef1e5649cd47fca423ad1bb7669a03"
],
"user": {
"gresetPassword": "no",
"nativeUser": true,
"registerTime": "1597994535235",
"fullName": "张三",
"active": "1",
"telephone": "12345678910",
"guserType": "0",
"guser": "users/24a5f120364a43798eba408cd05ec6f5",
"lastLoginTime": "1597994535682",
"name": "zs123456",
"guid": "94ac2ed5b8094af19fe357395068d4b7",
"bosclass": "users",
"userType": "0",
"id": "94ac2ed5b8094af19fe357395068d4b7",
"email": "123456789@qq.com",
"gcreatetime": "1597994535454"
}
}
}