认证
会员注册与登录能力,全部为公开接口(退出除外)。
手机号验证码注册
接口地址
text
POST /api/auth/register接口说明
仅支持手机号+验证码注册。默认昵称与头像取平台配置中的用户端配置, 注册来源记录 X-Platform-Source,注册成功后直接登录并返回令牌。 用户编号 sn 由服务端生成,全局唯一。
接口参数说明
| Header 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Platform-Source | integer | 是 | 平台来源 1微信小程序 2微信公众号 3iOS 4Android |
X-App-Version | string | 否 | 客户端版本号,服务端仅透传记录 |
| Body 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
mobile | string | 是 | 手机号 |
code | string | 是 | 短信验证码(6位) |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"token": ""
}
}响应参数说明
| 响应字段 | 类型 | 说明 |
|---|---|---|
token | string | JWT 访问令牌,携带会员ID、昵称、编号、头像与会话ID |
账号密码登录
接口地址
text
POST /api/auth/login_password接口说明
账号不存在时返回「账号不存在」;账号未设置密码时提示使用短信验证码登录。
接口参数说明
| Header 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Platform-Source | integer | 是 | 平台来源 1微信小程序 2微信公众号 3iOS 4Android |
X-App-Version | string | 否 | 客户端版本号,服务端仅透传记录 |
| Body 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
account | string | 是 | 登录账号 |
password | string | 是 | 登录密码 |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"token": ""
}
}响应参数说明
| 响应字段 | 类型 | 说明 |
|---|---|---|
token | string | JWT 访问令牌,携带会员ID、昵称、编号、头像与会话ID |
手机号验证码登录
接口地址
text
POST /api/auth/login_sms接口说明
手机号未注册时返回「账号不存在,请先注册」。
接口参数说明
| Header 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Platform-Source | integer | 是 | 平台来源 1微信小程序 2微信公众号 3iOS 4Android |
X-App-Version | string | 否 | 客户端版本号,服务端仅透传记录 |
| Body 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
mobile | string | 是 | 手机号 |
code | string | 是 | 短信验证码(6位) |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"token": ""
}
}响应参数说明
| 响应字段 | 类型 | 说明 |
|---|---|---|
token | string | JWT 访问令牌,携带会员ID、昵称、编号、头像与会话ID |
退出登录
接口地址
text
POST /api/auth/logout接口说明
删除当前会话缓存,当前令牌立即失效。
接口参数说明
| Header 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Platform-Source | integer | 是 | 平台来源 1微信小程序 2微信公众号 3iOS 4Android |
X-App-Version | string | 否 | 客户端版本号,服务端仅透传记录 |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"msg": "",
"data": null
}
}响应参数说明
成功时 data 为 null。