注意，这个文件必须以UTF-8无BOM格式编码。
| 序号 | 版本号 | 修改人 | 修改时间 | 修改内容简介 |
|---|---|---|---|---|
| 01 | 0.1 | skaic | 2017-11-02 | 初步划分接口模块和设计基础接口 |
[TOC]
用户系统
1. 开户业务
1.1 简易开户
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 简易开户 | jru-1001 | register | 创建新用户信息 |
请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 手机号码 | 选填 | 11位纯数字 | 登录使用的手机号码 （手机或邮箱必选其一） |
| 邮箱地址 | 选填 | 1 标准邮箱 2 最长128个字母 3 全部转小写保存 |
登录使用的手机号码 （手机或邮箱必选其一） |
| 登陆密码 | 必填 | MD5(MD5(密码原文))，两次MD5加密后上传 | |
| 支付密码 | 选填 | MD5(MD5(密码原文))，支付密码不能与登陆密码相同 | |
| 验证码编号 | 选填 | 由验证码发送接口提供 | |
| 验证码 | 选填 | 验证码在规定的时间段内且一次性验证有效 | |
| 用户姓名 | 选填 | 用户真实姓名 | |
| 证件国别 | 选填 | ||
| 证件类型 | 选填 | ||
| 证件号码 | 选填 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户状态 | 必回 |
业务处理流程
待补充
1.2 用户激活
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 用户激活 | jru-1002 | userActivation | 预开户状态用户进行支付密码信息设置，实现用户状态正常化。 |
请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 用户号 | 选填 | 用户号 或 用户标识 选其一 | |
| 用户标识 | 选填 | 用户号 或 用户标识 选其一 | |
| 支付密码 | 必填 | ||
| 验证码编号 | 选填 | 由验证码发送接口提供 | |
| 验证码 | 选填 | 验证码在规定的时间段内且一次性验证有效 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户状态 | 必回 |
业务处理流程
待补充
2. 信息业务
2.1 用户基础信息查询
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 用户基础信息查询 | jru-2001 | getUserInfoByUserId | 根据指定用户ID获取用户的基本信息 |
请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 用户号 | 选填 | 用户号 或 登陆标识 必选其一 | |
| 登陆标识 | 选填 | 用户号 或 登陆标识 必选其一 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户信息对象 | 必回 |
业务处理流程
待补充
2.2 用户基础信息更新
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 用户基础信息更新 | jru-2002 | updateUserInfo |
请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 用户号 | 必填 | ||
| 用户姓名 | 必填 | 用户真实姓名 | |
| 用户性别 | 必填 | ||
| 证件国别 | 必填 | ||
| 证件类型 | 必填 | ||
| 证件号码 | 必填 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户状态 | 必回 |
业务处理流程
待补充
3. 鉴权
3.1 登陆密码鉴权
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 登陆密码鉴权 | jru-3001 | authLoginPwd |
请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 登录标识 | 必填 | 登录标识（手机号、邮箱、昵称） | |
| 登陆密码 | 必填 | ||
| 短信验证码 | 可选 | 验证码 和 验证码编号 同时传递 | |
| 验证码编号 | 可选 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户信息对象 | 选回 | ||
| 连续错误次数 | 选回 | ||
| 累计错误次数 | 选回 | ||
| 剩余可用连续错误次数 | 选回 | ||
| 剩余可用累计错误次数 | 选回 |
业务处理流程
待补充
3.2 支付密码鉴权
3.3 发送短信验证码
4. 销户
4.1 用户销户
接口简介
| 接口名称 | 接口编号 | 交易代码 | 备注 |
|---|---|---|---|
| 用户销户 | jru-1002 | closeUser |
#####请求参数
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 用户号 | 必填 | ||
| 销户原因 | 选填 | ||
| 操作员 | 选填 | ||
| 授权操作员 | 选填 |
返回结果
| 名称 | 属性 | 业务规则 | 备注 |
|---|---|---|---|
| 执行结果 | 必回 | ||
| 失败原因 | 选回 | ||
| 用户号 | 必回 | ||
| 用户状态 | 必回 |
业务处理流程
待补充