Server接口

本接口主要实现用户操作相关功能

接口地址。仅支持HTTPS协议，请求方法仅支持POST，POST内容为JSON格式

https://server.bandoristation.com/

! 本接口中大部分请求方法都需要设置“Auth-Token”请求头，内容为登陆时服务器返回的Token值。需要设置请求头的请求会标注说明，具体添加内容不再下面赘述

菜单

• 用户登陆
  • 登陆账号
  • 退出登陆
  • 注册账号
  • 获取注册时设置的邮箱地址
  • 修改注册时设置的邮箱地址
  • 发送邮箱验证码
  • 验证邮箱
  • 重置密码发送邮箱验证码
  • 重置密码验证邮箱
  • 重置密码
• 主界面操作
  • 初始化账号数据
  • 获取房间号筛选设置
  • 更新房间号筛选设置
  • 举报用户

用户登陆

登陆账号

获取用户访问Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	login
username	string	用户名	可以是用户名或者邮箱地址
password	string	用户密码

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

status为success将会返回两种结果，登陆成功或者需要验证邮箱

登陆成功：

字段名	数据类型	说明
token	string	用户访问长期Token，有效期30天，用来授权访问Server以及部分WebSocket接口
avatar	string	用户头像文件名，头像文件可以从地址 https://assets.bandoristation.com/images/user-avatar/{avatar} 获取

需要验证邮箱：

字段名	数据类型	说明
token	string	用来验证的临时Token，有效期10分钟，仅可用作验证访问授权，验证完成之后即丢弃
redirect_to	string	重定向页面地址，此处固定为“verify-email”

退出登陆

※需要设置请求头

清除服务端用户登陆状态

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	logout

响应数据

字段名	数据类型	说明
status	string	success/failure
response	string	status为success时返回空字符串，为failure时返回原因

注册账号

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	signup
username	string	用户名
password	string	密码
email	string	邮箱地址

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
token	string	用来验证的临时Token，有效期10分钟，仅可用作验证访问授权，验证完成之后即丢弃
redirect_to	string	重定向页面地址，此处固定为“verify-email”

获取注册时设置的邮箱地址

※需要设置请求头，内容为验证用临时Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	getCurrentEmail

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
email	string	注册时设置的邮箱地址

修改注册时设置的邮箱地址

※需要设置请求头，内容为验证用临时Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	changeEmail
email	string	新的邮箱地址

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
new_email	string	修改后的邮箱地址

发送邮箱验证码

※需要设置请求头，内容为验证用临时Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	sendEmailVerificationCode

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
email	string	发送验证码到的邮箱地址

验证邮箱

※需要设置请求头，内容为验证用临时Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	verifyEmail
verification_code	string	发送到邮箱的验证码

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
token	string	用户访问长期Token，有效期30天，用来授权访问Server以及部分WebSocket接口
avatar	string	用户头像文件名，头像文件可以从地址 https://assets.bandoristation.com/images/user-avatar/{avatar} 获取

重置密码发送邮箱验证码

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	resetPasswordSendEmailVerificationCode
email	string	账号绑定的邮箱地址

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
email	string	发送验证码到的邮箱地址

重置密码验证邮箱

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	verifyEmail
verification_code	string	发送到邮箱的验证码

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
token	string	用来重置密码的临时Token，有效期10分钟，仅可用作重置密码，重置完成之后即丢弃

重置密码

※需要设置请求头，内容为重置密码用临时Token

参数

字段名	数据类型	填入值	说明
function_group	string	UserLogin
function	string	resetPassword
password	string	新的密码

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回空字符串，为failure时返回原因

主界面操作

初始化账号数据

※需要设置请求头

参数

字段名	数据类型	填入值	说明
function_group	string	MainAction
function	string	initializeAccountSetting

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
avatar	string	用户头像文件名，头像文件可以从地址 https://assets.bandoristation.com/images/user-avatar/{avatar} 获取

获取房间号筛选设置

※需要设置请求头

参数

字段名	数据类型	填入值	说明
function_group	string	MainAction
function	string	getRoomNumberFilter

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回object，为failure时返回原因

response:

字段名	数据类型	说明
type	array	房间号类型
keyword	array	筛选关键字
user	array	筛选用户

type数组元素包含“7”、“12”、“18”、“25”、“other” user数组元素为对象，结构如下

字段名	数据类型	说明
type	string	用户类型
user_id	number	用户ID

房间号筛选设置JSON结构示例如下：

{
  "type":[
    "7",
    "12",
    "other"
  ],
  "keyword":[
    "跳",
    "小分"
  ],
  "user":[
    {
      "type":"qq",
      "user_id":123456789
    },
    {
      "type":"local",
      "user_id":12345
    }
  ]
}

更新房间号筛选设置

※需要设置请求头

参数

字段名	数据类型	填入值	说明
function_group	string	MainAction
function	string	updateRoomNumberFilter
room_number_filter	object	房间号筛选设置	格式见上方说明

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回空字符串，为failure时返回原因

举报用户

※需要设置请求头

参数

字段名	数据类型	填入值	说明
function_group	string	MainAction
function	string	informUser
type	string	用户类型	获取自房间号消息
user_id	number	用户ID	获取自房间号消息
raw_message	string	房间号消息原文	获取自房间号消息
reason	string	举报原因

响应数据

字段名	数据类型	说明
status	string	success/failure
response	object/string	status为success时返回空字符串，为failure时返回原因