XXX公司
XXXXXXXX接口规范
作者：xxx
版本：1.0.1
创建日期：2020年4月20日
修订历史版本
| 日期 | 版本 | 说明 | 作者 |
| 2020-4-20 | 1.0 | 初版 | xxx |
本文档详细定义了某某某系统对外提供接口规范和调用方法。
1 登录接口规范；
2 修改密码接口规范；
3 编辑资料接口规范；
4 其它；
本文档旨在给第三方实现接口开发提供参考。
2、接口规范
2.1 测试地址
例：http://xxx.x.x.x:8080/
2.2 签名方法
例：sign=Md5(字段1+字段2+字段3+秘钥)；
注：秘钥请联系业务人员获取，一般不会公开使用。
2.3 加密解密
加密：所有字段都必须加密后请求，否则调用失败，sign字段请拼接完成后再使用加密方法。
解密：返回报文data字段需解密操作。
附件：提供加解密方法。
2.4 其它公共内容
可自行添加。
2.5 接口请求详细
2.5.1 登录接口规范
| 功能描述 | |||
| 该接口是实现调用验证登录及获取登录信息。 | |||
| 接口方式 | http POST | ||
| 接口地址 | http://应用地址/登录地址/xxx | ||
| 接口方法 | |||
| 请求字段 | |||
| 参数名 | 中文描述 | 类型 | 约束 |
| sign | 签名 | String | 必填 |
| code | 工号 | String | 必填 |
| passWord | 密码 | String | 必填 |
| 返回（JSON 格式） | |||
| 参数 | 说明 | ||
| res_code | 返回码 | ||
| res_msg | 结果提示信息 | ||
| data | 用户信息 | ||
| [ { "name": "姓名 "age": "年龄 "sex"："性别", } ] | |||
| 功能描述 | |||
| 该接口是实现调用修改密码。 | |||
| 接口方式 | http POST | ||
| 接口地址 | http://应用地址/修改密码/xxx | ||
| 接口方法 | |||
| 请求字段 | |||
| 参数名 | 中文描述 | 类型 | 约束 |
| sign | 签名 | String | 必填 |
| code | 工号 | String | 必填 |
| passWord | 密码 | String | 必填 |
| newPassword | 新密码 | String | 必填 |
| 返回（JSON 格式） | |||
| 参数 | 说明 | ||
| res_code | 返回码 | ||
| res_msg | 结果提示信息 | ||
| 功能描述 | |||
| 该接口是实现调用修改用户资料。 | |||
| 接口方式 | http POST | ||
| 接口地址 | http://应用地址/编辑资料/xxx | ||
| 接口方法 | |||
| 请求字段 | |||
| 参数名 | 中文描述 | 类型 | 约束 |
| sign | 签名 | String | 必填 |
| code | 工号 | String | 必填 |
| passWord | 密码 | String | 必填 |
| age | 年龄 | String | 选填 |
| sex | 性别 | String | 选填 |
| name | 姓名 | String | 选填 |
| 返回（JSON 格式） | |||
| 参数 | 说明 | ||
| res_code | 返回码 | ||
| res_msg | 结果提示信息 | ||
| 功能描述 | |||
| 该接口是实现调用验证其它功能。 | |||
| 接口方式 | http POST | ||
| 接口地址 | http://应用地址/其它/xxx | ||
| 接口方法 | |||
| 请求字段 | |||
| 参数名 | 中文描述 | 类型 | 约束 |
| Xxx | Xxx | String | 必填 |
| Xxx | Xxx | String | 必填 |
| Xxx | Xxx | String | 必填 |
| 返回（JSON 格式） | |||
| 参数 | 说明 | ||
| res_code | 返回码 | ||
| res_msg | 结果提示信息 | ||
| data | 用户信息 | ||
| [ { "xxx": "xxx "xxx": "xxx "xxx"："xxx", } ] | |||
| 序号 | 返回码 | 说明 |
| 1 | 0000 | 验证通过，请求成功！ |
| 2 | 0001 | 验证失败，请求失败！ |
| 3 | 0002 | 加密失败，请求失败！ |
| 4 | 0003 | 工号或密码错误，登录失败！ |
| 5 | 0004 | 修改成功！ |
| 6 | 500 | 系统内部错误！ |
