[关闭]
@contribute 2018-04-17T18:46:18.000000Z 字数 3507 阅读 1764

认证中心文档

tanzhou 认证中心

公共信息

公共请求头参数

参数 类型 必须 说明 默认值 举例
terminalType Integer 是 调用端来源：枚举详解 无 1
machineCode String 否 调用端机器码，APP端必须传 无 1315436616

1. 发送短信验证码

发送短信验证码，用于手机验证码登录，手机号注册，绑定手机号等操作之前使用。

1.1 接口定义

名称 说明
请求方法 GET
访问路径 /verify/sms/send
调用端 PC端，M站，APP

请求参数

序列 参数 类型 必须 说明 默认值
1 phone String 是 手机号 86-18684948111

响应参数：

参数 类型 必须 说明 默认值

成功响应示例：

  1. {
  2.   "traceId": "21ec9773b7a6692c",
  3.   "status": "0",
  4.   "msg": "",
  5.   "data": { }
  6. }

2. 手机登录

发送短信验证码，用于手机验证码登录，手机号注册，绑定手机号等操作之前使用。

2.1 接口定义

名称 说明
请求方法 GET
访问路径 /login/phone
调用端 PC端，WEB端，M站，APP

请求参数

参数 类型 必须 说明 默认值
phone String 是 手机号 86-18684948111
code String 是 手机验证码 2314

响应参数：

参数 类型 是否必须 说明 默认值
token String 是 用户唯一标示 3310133714426314491

成功响应实例：

  1. {
  2. "traceId": "11cec05851700436",
  3. "status": "0",
  4. "msg": "",
  5. "data": {
  6.   "token": "3310133714426314491"
  7.   }
  8. }

2.2 流程图

Created with Raphaël 2.1.2开始手机是否已注册错误返回结束验证码是否正确成功返回yesnoyesno

3. 标准登录

通过用户名和密码登录。

3.1 接口定义

名称 说明
请求方法 POST
访问路径 /login/standard
调用端 PC端，M站，APP

请求参数

序号 参数 类型 必须 说明 默认值
1 account String 是 用户账户 m18711727261

响应参数：

序号 参数 类型 必须 说明 默认值
1 token String 是 用户唯一标示 3414361613461466

成功响应实例：

  1. {
  2.     "traceId": "a2413d5a736ee061",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": {
  6.         "token": "0551789651431368024"
  7.     }
  8. }

3.2 流程图

Created with Raphaël 2.1.2开始账号是否存在密码是否正确成功返回结束错误返回yesnoyesno

4 查询登录用户详情

查询登录用户详情，后台会缓存此用户的token与用户详情的对应关系。

4.1 接口定义

名称 说明
请求方法 GET
访问路径 /login/phone
调用端 PC端，M站，APP

请求参数

参数 类型 必须 说明 默认值
token String 是 用户唯一标示 3414361613461466

响应参数：

序号 参数 类型 必须 说明 默认值
1 result Struct 是
1.1 account String 是 用户账户 m18684948666
1.2 uid Long 是 用户ID 2
1.3 icon String 否 用户头像地址
1.4 description String 是 用户简介 你很帅
1.5 gender Integer 是 性别，所有枚举类型：枚举 1

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": {
  6.         "result": {
  7.             "account": "m18684948666",
  8.             "uid": 2,
  9.             "nick": "你很帅",
  10.             "icon": "",
  11.             "description": "",
  12.             "gender": 1,
  13.             "birthday": "",
  14.             "phone": "18684948666",
  15.             "email": "",
  16.             "qq": "454250944"
  17.         }
  18.     }
  19. }

4.2 流程图

Created with Raphaël 2.1.2开始token是否在缓存中成功返回结束错误返回yesno

5 校验手机号是否可注册或绑定

校验手机号是否可注册或绑定，在绑定手机，手机注册，重置手机时会被调用。

5.1 接口定义

名称 说明
请求方法 GET
访问路径 /verify/available/phone
调用端 PC端，M站，WEB端，APP

请求参数

序列 参数 类型 必须 说明 默认值
1 phone String 是 手机号 86-18684948111

响应参数：

序号 参数 类型 必须 说明 默认值

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": { }
  6.     }
  7. }

5.2 流程图

Created with Raphaël 2.1.2开始手机是否在缓存中成功返回结束手机是否在数据库中错误返回yesnoyesno

6 发送邮件

发送邮件，邮箱发送三次验证码且验证失败需输入图形验证码，邮箱通过验证后重置发送验证码次数为0

6.1 接口定义

名称 说明
请求方法 POST
访问路径 /verify/available/phone
调用端 PC端，M站，WEB端，APP

请求参数

序列 参数 类型 必须 说明 默认值
1 email String 是 邮箱地址 hello@123.com
2 imageCode String 否 图形验证码 5254
3 uniqueId String 否 图形验证码对应uuid 2232JLJJJK26

响应参数：

序号 参数 类型 必须 说明 默认值

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": { }
  6.     }
  7. }

6.2 流程图

Created with Raphaël 2.1.2开始是否超过三次图形验证码是否正确验证码是否正确成功返回结束错误返回yesnoyesnoyesno

7 生成图形验证码

生成图形验证码，当手机验证码或邮箱验证码验证多次不成功时，要求校验图形验证码。

7.1 接口定义

名称 说明
请求方法 POST
访问路径 /verify/imageCode/create
调用端 PC端，M站，WEB端，APP

请求参数

序列 参数 类型 必须 说明 默认值

响应参数：

序号 参数 类型 必须 说明 默认值

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": { }
  6.     }
  7. }

8 用户注册

用户只能通过手机号进行注册。

8.1 接口定义

名称 说明
请求方法 POST
访问路径 /verify/imageCode/create
调用端 PC端，M站，WEB端，APP

请求参数

序列 参数 类型 必须 说明 示例
1 phone String 是 手机号 86-18684948111
2 code String 是 手机验证码 8111
3 nick String 是 昵称 这么名字好难取
4 pwd String 是 密码（base64+md5加密）
5 token String 是 用户唯一标示 3310133714426314491

响应参数：

序号 参数 类型 必须 说明 默认值

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": { }
  6.     }
  7. }

8.2 流程图

Created with Raphaël 2.1.2开始参数正常手机不存在手机验证码正确成功返回结束错误返回yesnoyesnoyesno

9 手机号重置密码

用户通过手机号及手机验证码的方式重置密码

9.1 接口定义

名称 说明
请求方法 POST
访问路径 /update/password/phone
调用端 PC端，M站，WEB端，APP

请求参数

序列 参数 类型 是否必须 说明 示例
1 phone String 是 手机号 86-18684948111
2 code String 是 手机验证码 8111
3 pwd String 是 密码（base64+md5加密）

响应参数：

序号 参数 类型 是否必须 说明 默认值

成功响应实例：

  1. {
  2.     "traceId": "86b81ea5b4937044",
  3.     "status": "0",
  4.     "msg": "",
  5.     "data": { }
  6.     }
  7. }

9.2 流程图

Created with Raphaël 2.1.2开始参数正常手机是用户绑定的手机号手机验证码正确更新密码成功返回结束错误返回yesnoyesnoyesno
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注