IconCreated with Sketch.

YAPI 接口文档

YApi
  • 公共分类
    • 协议规则
    • 发送短信验证码
    • 手机号登录

H5盲盒

公共分类

协议规则

基本信息

Path: /api/common/agreement

Method: POST

接口描述:

返回示例:

{
    "code": 1,
    "msg": "查询成功",
    "data": {
        "content": "<h1>Hello World</h1>"
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 user_agreement 协议名称:用户协议user_agreement,隐私政策privacy_policy,玩法规则play_rule,充值协议play_rule,买家须知notice_to_buyers

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须接口状态:1成功,0失败
msgstring非必须接口消息
dataobject非必须接口数据
├─ contentstring非必须协议内容(富文本)

发送短信验证码

基本信息

Path: /api/sms/send

Method: POST

接口描述:

返回示例:

{
    "code": 1,
    "msg": "发送成功",
    "data": null
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mobile text 是 18888888888 手机号
event text 是 login 事件:登录login,更换手机号changemobile,修改密码changepwd,重置密码:resetpwd

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须接口状态:1成功,0失败,401请登录
msgstring非必须接口消息
datanull非必须接口数据

手机号登录

基本信息

Path: /api/user/mobilelogin

Method: POST

接口描述:

返回示例:

{
    "code": 1,
    "msg": "登录成功",
    "data": {
        "nickname": "188****8888",
        "mobile": "18888888888",
        "avatar": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgaGVpZ2h0PSIxMDAiIHdpZHRoPSIxMDAiPjxyZWN0IGZpbGw9InJnYigyMjksMTYwLDE4MykiIHg9IjAiIHk9IjAiIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48L3JlY3Q+PHRleHQgeD0iNTAiIHk9IjUwIiBmb250LXNpemU9IjUwIiB0ZXh0LWNvcHk9ImZhc3QiIGZpbGw9IiNmZmZmZmYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIHRleHQtcmlnaHRzPSJhZG1pbiIgZG9taW5hbnQtYmFzZWxpbmU9ImNlbnRyYWwiPjE8L3RleHQ+PC9zdmc+",
        "token": "efed8cf6-0e80-4991-9016-69df7bbad85c"
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mobile text 是 18888888888 手机号
captcha text 是 123456 短信验证码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须接口状态:1成功,0失败,401请登录
msgstring非必须接口消息
dataobject非必须接口数据
├─ nicknamestring非必须昵称
├─ mobilestring非必须手机
├─ avatarstring非必须头像
├─ tokenstring非必须TOKEN

Build by YMFE.