[关闭]
@sewise-dev 2018-05-08T08:15:29.000000Z 字数 8705 阅读 578

（用户中心）VPaas平台PHP API接口文档

VPaas组件化 用户中心

更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 Seven 2016-12-12

目录

1. 全局返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

返回码 说明
-1 系统繁忙，此时请开发者稍候再试
200 请求成功
403 禁止访问
404 异常错误
500 数据验证错误
40001 不合法的凭证，或者access_token无效。
40004 不合法请求

HTTP请求状态返回格式

返回字段 字段类型 说明
status Integer 请求返回码(详细请见状态表)
message String 返回描述
data Array 返回结果

错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}

1.用户中心

1.1 用户注册

接口地址

/v1/user/register

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 Long 手机号
password 是 String 密码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":13453077412，"password":"123456"} http://usercenter.sewise.com/v1/user/register
Response
{"status":200,"data":{"userId":"31"}}

1.2 用户登录

接口地址

/v1/user/auth

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 Long 手机号
password 是 String 密码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message Array 返回错误信息
data Array 返回结果
dataItem
userId int 用户id
access_token String 返回授权签名
expire String 签名过期时间，默认24小时有效
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":13453077412，"password":"123456"} http://usercenter.sewise.com/v1/user/auth
Response
{"status":200,"data":{"userId":"23","access_token":"JfKXafCnfSZrCEkShTIcM3suBFwUBAQi3eocJ5Ol","expire":"2016-07-09 10:51:25"}}

1.3 用户基本信息

接口地址

/v1/user/accountInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）

例如： /v1/user/accountInfo?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://usercenter.sewise.com/v1/user/accountInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18675448003","userType":"1","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-06 17:42:22","isDelete":"N"}}

1.4 用户详细信息

接口地址

/v1/user/userInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）

例如： /v1/user/userInfo?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://usercenter.sewise.com/v1/user/userInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18666666776","email":"123456@163.com",
"emailVerify":"1","userType":"1","rank":"0","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-19 11:01:40","isDelete":"N","fId":"2",
"nickName":"\u5f20\u4e09",
"address":"\u6df1\u5733\u5e02\u77fd\u4f1f\u667a\u79d1\u6280
\u6709\u9650\u516c\u53f8","bindValue":"8837263462364"}}

1.5 编辑用户基本信息

接口地址

/v1/user/edit

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 否 String 要更改成的手机号码
userType 否 int 用户类型：管理用户，普通用户
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
nickName 否 String 用户昵称
address 否 String 用户的通信地址（公司地址）
bindValue 否 String 绑定的值（qq）
.....

例如： /v1/user/edit?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
nickName 否 String 用户昵称
address 否 String 用户的通信地址（公司地址）
bindValue 否 String 绑定的值（qq）
.....

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
nickName 否 String 用户昵称
address 否 String 用户的通信地址（公司地址）
bindValue 否 String 绑定的值（qq）
.....

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
nickName 否 String 用户昵称
address 否 String 用户的通信地址（公司地址）
bindValue 否 String 绑定的值（qq）
.....
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","mobile":"13424284710","email":"123456@163.com",“userType”:"1"，"token":"#########"} http://usercenter.sewise.com/v1/user/edit
Response
{"status":200,"message":["\u4fee\u6539\u6210\u529f"]}

1.6 验证已登录用户密码

接口地址

/v1/user/authPass

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

例如： /v1/user/authPass?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://usercenter.sewise.com/v1/user/authPass
Response
{"status":200,"message":["\u5bc6\u7801\u6b63\u786e"]}

1.7 重置密码

接口地址

/v1/user/reset

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

例如： /v1/user/reset?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message Array 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://usercenter.sewise.com/v1/user/reset
Response
{"status":200,"message":["\u5bc6\u7801\u91cd\u7f6e\u6210\u529f"]}

1.8 登录记录

接口地址

/v1/user/record

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

例如： /v1/user/record?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message Array 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"32"，"token":"#########"，"page":"1","pageSize":"20","order":"aId DESC"} http://usercenter.sewise.com/v1/user/record
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{"area":"\u5e7f\u4e1c \u6df1\u5733","ip":"127.0.0.1","loginDate":"2016-07-18 13:46:50"}]}}

1.9 手机号是否存在

接口地址

/v1/user/checkMobile

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 是 int 手机号

例如： /v1/user/checkMobile?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 是 int 手机号

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
mobile 是 int 手机号

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
mobile 是 int 手机号
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message Array 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13812345678"，"token":"#########"} http://usercenter.sewise.com/v1/user/checkMobile
Response
{"status":200,"data":{"userId":"16"}}

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注