认证

会员注册与登录能力，全部为公开接口（退出除外）。

手机号验证码注册

接口地址

text

POST /api/auth/register

接口说明

手机号+验证码注册是注册方式之一；小程序端也可通过 code 登录自动创建会员，手机号不强制。默认昵称与头像取平台配置中的用户端配置，注册来源记录 X-Platform-Source，注册成功后直接登录并返回令牌。用户编号 sn 由服务端生成，全局唯一。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	平台来源 1微信小程序 2微信公众号 3iOS 4Android 5H5 6支付宝小程序 7百度小程序 8抖音小程序 9QQ小程序 10快手小程序
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录

Body 参数	类型	必填	说明
`mobile`	`string`	是	手机号
`code`	`string`	是	短信验证码（6位）

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "token": "",
    "platform": 0,
    "platform_bind_required": false,
    "platform_configured": false,
    "platform_bind_mode": 0
  }
}

响应参数说明

响应字段	类型	说明
`token`	`string`	JWT 访问令牌，携带会员ID、昵称、编号、头像与会话ID
`platform`	`integer`	待绑定小程序平台，非小程序端为0
`platform_bind_required`	`boolean`	是否需要异步绑定当前小程序身份
`platform_configured`	`boolean`	当前小程序是否已配置可用开发信息
`platform_bind_mode`	`integer`	0无需绑定 1小程序code绑定 2微信公众号网页OAuth

账号密码登录

接口地址

text

POST /api/auth/login_password

接口说明

账号不存在时返回「账号不存在」；账号未设置密码时提示使用短信验证码登录。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	平台来源 1微信小程序 2微信公众号 3iOS 4Android 5H5 6支付宝小程序 7百度小程序 8抖音小程序 9QQ小程序 10快手小程序
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录

Body 参数	类型	必填	说明
`account`	`string`	是	登录账号
`password`	`string`	是	登录密码

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "token": "",
    "platform": 0,
    "platform_bind_required": false,
    "platform_configured": false,
    "platform_bind_mode": 0
  }
}

响应参数说明

响应字段	类型	说明
`token`	`string`	JWT 访问令牌，携带会员ID、昵称、编号、头像与会话ID
`platform`	`integer`	待绑定小程序平台，非小程序端为0
`platform_bind_required`	`boolean`	是否需要异步绑定当前小程序身份
`platform_configured`	`boolean`	当前小程序是否已配置可用开发信息
`platform_bind_mode`	`integer`	0无需绑定 1小程序code绑定 2微信公众号网页OAuth

手机号验证码登录

接口地址

text

POST /api/auth/login_sms

接口说明

手机号未注册时返回「账号不存在，请先注册」。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	平台来源 1微信小程序 2微信公众号 3iOS 4Android 5H5 6支付宝小程序 7百度小程序 8抖音小程序 9QQ小程序 10快手小程序
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录

Body 参数	类型	必填	说明
`mobile`	`string`	是	手机号
`code`	`string`	是	短信验证码（6位）

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "token": "",
    "platform": 0,
    "platform_bind_required": false,
    "platform_configured": false,
    "platform_bind_mode": 0
  }
}

响应参数说明

响应字段	类型	说明
`token`	`string`	JWT 访问令牌，携带会员ID、昵称、编号、头像与会话ID
`platform`	`integer`	待绑定小程序平台，非小程序端为0
`platform_bind_required`	`boolean`	是否需要异步绑定当前小程序身份
`platform_configured`	`boolean`	当前小程序是否已配置可用开发信息
`platform_bind_mode`	`integer`	0无需绑定 1小程序code绑定 2微信公众号网页OAuth

小程序 code 登录

接口地址

text

POST /api/auth/login_miniprogram

接口说明

平台由 X-Platform-Source 决定，服务端使用后台配置的对应小程序 AppID 与 AppSecret 换取 openid。 openid 已绑定会员时直接登录；未绑定则自动创建会员并写入平台身份，手机号不是登录必需项，新会员的账号、密码与手机号均为空。登录后可通过手机号管理接口绑定或更换手机号。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	小程序平台来源：1微信 6支付宝 7百度 8抖音 9QQ 10快手
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录
`X-Platform-App-Id`	`string`	否	平台应用ID，存在多个已启用应用时必填

Body 参数	类型	必填	说明
`code`	`string`	是	小程序 `login` 接口返回的一次性凭证
`app_id`	`string`	否	平台应用ID，多应用场景必填

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "token": "",
    "platform": 1,
    "platform_bind_required": false,
    "platform_configured": true,
    "platform_bind_mode": 1
  }
}

响应参数说明

响应字段	类型	说明
`token`	`string`	JWT 访问令牌，携带会员ID、昵称、编号、头像与会话ID
`platform`	`integer`	当前小程序平台
`platform_bind_required`	`boolean`	code 登录已完成绑定，固定为 false
`platform_configured`	`boolean`	当前小程序是否已配置可用开发信息
`platform_bind_mode`	`integer`	1 小程序 code 绑定

退出登录

接口地址

text

POST /api/auth/logout

接口说明

删除当前会话缓存，当前令牌立即失效。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	平台来源 1微信小程序 2微信公众号 3iOS 4Android 5H5 6支付宝小程序 7百度小程序 8抖音小程序 9QQ小程序 10快手小程序
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "code": 0,
    "msg": "",
    "data": null
  }
}

响应参数说明

成功时 data 为 null。

忘记密码后重置密码

接口地址

text

POST /api/auth/password/reset

接口说明

使用场景4的短信验证码验证已绑定手机号；密码至少6位且同时包含字母和数字。成功后该账号所有已有会话失效。

接口参数说明

Header 参数	类型	必填	说明
`X-Platform-Source`	`integer`	是	平台来源 1微信小程序 2微信公众号 3iOS 4Android 5H5 6支付宝小程序 7百度小程序 8抖音小程序 9QQ小程序 10快手小程序
`X-App-Version`	`string`	否	客户端版本号，服务端仅透传记录

Body 参数	类型	必填	说明
`mobile`	`string`	是	已绑定手机号
`code`	`string`	是	场景4短信验证码
`new_password`	`string`	是	新密码，至少6位且同时包含字母和数字

响应示例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "code": 0,
    "msg": "",
    "data": null
  }
}

响应参数说明

成功时 data 为 null。

认证 ​

手机号验证码注册 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

账号密码登录 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

手机号验证码登录 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

小程序 code 登录 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

退出登录 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

忘记密码后重置密码 ​

接口地址 ​

接口说明 ​

接口参数说明 ​

响应示例 ​

响应参数说明 ​

认证

手机号验证码注册

接口地址

接口说明

接口参数说明

响应示例

响应参数说明

账号密码登录

接口地址

接口说明

接口参数说明

响应示例

响应参数说明

手机号验证码登录

接口地址

接口说明

接口参数说明

响应示例

响应参数说明

小程序 code 登录

接口地址

接口说明

接口参数说明

响应示例

响应参数说明

退出登录

接口地址

接口说明

接口参数说明

响应示例

响应参数说明

忘记密码后重置密码

接口地址

接口说明

接口参数说明

响应示例

响应参数说明