Skip to content

openApi

wuxw7 edited this page Dec 1, 2018 · 4 revisions

变更历史

版本 变更内容 变更时间 变更人员
v0.01 初稿 2018-11-24 wuxw

用户注册

请求地址

http://localhost:8008/api/user.service.register

请求方式

POST

请求协议(header部分)

参数名称 约束 类型 长度 描述 取值说明
app_id 1 String 30 应用ID Api服务分配
transaction_id 1 String 30 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列
sign 1 String - 签名 请参考签名说明
req_time 1 String - 请求时间 YYYYMMDDhhmmss

请求协议(body部分)

参数名称 约束 类型 长度 描述 取值说明
name 1 String 50 用户名称 -
email 1 String 30 邮箱地址 邮箱地址[email protected]
password 1 String 128 密码 加盐码md5
tel 1 String 11 手机号 11位手机号
sex ? String 1 性别 0表示男孩 1表示女孩

返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:

参数名称 约束 类型 长度 描述 取值说明
userId 1 String 30 用户名称 用户ID
responseTime ? String 16 时间 请求返回的时间

举例

请求报文:

{
     "name": "张三",
     "email": "[email protected]",
     "password": "ERCBHDUYFJDNDHDJDNDJDHDUDHDJDDKDK",
     "sex": "0",
     "tel": "17797173943"
}

返回报文:

{"responseTime":"20181125230634","userId":"30516389265349820416"}

用户登录

请求地址

http://api.java110.com:8008/api/user.service.login

请求方式

POST

请求协议(header部分)

请参考用户注册的头信息

请求协议(body部分)

参数名称 约束 类型 长度 描述 取值说明
username 1 String 50 用户名 -
passwd 1 String 30 密码 -

返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:

参数名称 约束 类型 长度 描述 取值说明
userName 1 String 30 用户名称 用户名称
userId 1 String 30 用户ID 用户ID
token ? String 64 鉴权码 鉴权码

举例

请求报文:

{
	"username":"admin",
	"passwd":"d57167e07915c9428b1c3aae57003807"
}

返回报文:

{"userName":"admin","userId":"10001","token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiNmUzZGNjMzM3YmE4NGRmMTgxNzcwNDVjOTIzOTljOTAifQ.oUotKsoy1TXBS37isSvwKTQ9c_tTxZS48TA554QdbEU"}

校验登录

请求地址

http://api.java110.com:8008/api/check.service.login

请求方式

POST

请求协议(header部分)

请参考用户注册的头信息

请求协议(body部分)

参数名称 约束 类型 长度 描述 取值说明
token 1 String 50 鉴权码 -

返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:

参数名称 约束 类型 长度 描述 取值说明
userId 1 String 30 用户ID 用户ID

举例

请求报文:

{
	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiOGU1ZGY4NjBhYTUyNDgyNzk3MjBjZDFjNzg3ZDk4OTkifQ.PGwR_YjIDwn8sQFKr7CDmUk87MYt1lgi1s7a5OrE_Jg"
}

返回报文:

{"userId":"10001"}