蓝莺开发者
Web & Mini ProgramiOSAndroidC++Server API

2 token 接口#

2.1 通过用户ID和密码取普通用户token#

POST /token/id

请求头#

参数名称数据类型必填描述
access-tokenstringfalse令牌
app_idstringtrue应用ID
group_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
user_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

请求体(Request Body)#

参数名称数据类型必填默认值描述
device_guidstringfalse设备ID, 如果设置,则返回PushToken
passwordstringtrue密码
user_idint64true用户ID,仅用于用户ID登录

响应体#

● 200 响应数据格式:JSON

参数名称类型描述
codeint32返回码,200是成功
dataobject结果数据
⇥ access_key_secretstring文件密钥
⇥ encrypt_typeint32是否启用加密连接
⇥ expireint64过期时间戳
⇥ public_keystring公钥
⇥ push_tokenstring推送Token
⇥ store_tokenstring文件token
⇥ tokenstring访问token, 即调用API时的access-token
⇥ user_idint64用户ID
messagestring错误信息,如果成功,该项为null

接口描述#

2.2 通过用户名/手机号/邮箱取普通用户token#

POST /token/login

请求头#

参数名称数据类型必填描述
access-tokenstringfalse令牌
app_idstringtrue应用ID
group_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
user_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

请求体(Request Body)#

参数名称数据类型必填默认值描述
device_guidstringfalse设备ID, 如果设置,则返回PushToken
login_namestringtrue登录名,可以是手机号,邮箱,用户名
passwordstringtrue密码

响应体#

● 200 响应数据格式:JSON

参数名称类型描述
codeint32返回码,200是成功
dataobject结果数据
⇥ access_key_secretstring文件密钥
⇥ encrypt_typeint32是否启用加密连接
⇥ expireint64过期时间戳
⇥ public_keystring公钥
⇥ push_tokenstring推送Token
⇥ store_tokenstring文件token
⇥ tokenstring访问token, 即调用API时的access-token
⇥ user_idint64用户ID
messagestring错误信息,如果成功,该项为null

接口描述#

2.3 通过用户名和密码取普通用户token#

POST /token/user

请求头#

参数名称数据类型必填描述
access-tokenstringfalse令牌
app_idstringtrue应用ID
group_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
user_idint64false仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

请求体(Request Body)#

参数名称数据类型必填默认值描述
device_guidstringfalse设备ID, 如果设置,则返回PushToken
namestringtrue用户名,仅用于用户名登录
passwordstringtrue密码

响应体#

● 200 响应数据格式:JSON

参数名称类型描述
codeint32返回码,200是成功
dataobject结果数据
⇥ access_key_secretstring文件密钥
⇥ encrypt_typeint32是否启用加密连接
⇥ expireint64过期时间戳
⇥ public_keystring公钥
⇥ push_tokenstring推送Token
⇥ store_tokenstring文件token
⇥ tokenstring访问token, 即调用API时的access-token
⇥ user_idint64用户ID
messagestring错误信息,如果成功,该项为null

接口描述#

自动生成的 API 内容,仅在必要位置补充精简的 AI 解释。