AI摘要
本文是傻猫软件开发的APP与BOSS系统对接的API文档,包括接口请求方式、参数签名规则、返回参数规范等。文档详细介绍了五个API接口:登录前配置信息、手机号+密码登录、手机号+验证码登录、获取验证码和修改密码,每个接口都有请求参数和响应示例。
本文是傻猫软件开发
APP 与 BOSS 系统对接 API 文档(开发方:傻猫软件)
所有接口使用HTTPS
请求,编码方式为UTF-8
,响应数据为JSON
格式。
参数签名规则(sign)
为确保接口安全,所有接口必须提供 sign
参数,进行数据验签。
- 签名方式:
将请求参数(不含 sign)按键名升序排序,拼接成字符串后用 Base64 加密,作为 sign 参数传入。
- 示例:
原始参数:client_type=Android&phone=13800000000&version=1.0
排序后拼接字符串:client_type=Android&phone=13800000000&version=1.0
Base64 加密结果:Y2xpZW50X3R5cGU9QW5kcm9pZCZwaG9uZT0xMzgwMDAwMDAwJnZlcnNpb249MS4w
注意事项:
- 签名必须由调用方正确生成,后台会进行同样规则验签
- 若验签失败将拒绝响应
返回参数规范
所有接口返回数据结构一致,结构如下:
{
"status": "success", // 或 "error"
"code": 200, // 状态码,定义如下
"message": "描述信息",
"data": {} // 具体返回数据内容
}
状态码 | 含义说明 |
---|---|
200 | 请求成功 |
400 | 参数错误 |
401 | 验证失败(如密码错误、验证码失效) |
403 | 无权限访问 |
500 | 服务器异常 |
1. 登录前的配置信息
描述:获取 APP 首屏展示配置(新闻、公告、协议等)
请求参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
version | string | 是 | APP 版本号 |
client\_ip | string | 是 | 客户端 IP |
client\_type | string | 是 | 客户端类型 |
sign | string | 是 | Base64 签名 |
响应示例
{
"status": "success",
"code": 200,
"message": "加载成功",
"data": {
"news": [],
"notices": [],
"agreements": []
}
}
2. 手机号+密码登录
描述:验证手机号及密码登录身份
请求参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
phone | string | 是 | 手机号 |
password | string | 是 | 登录密码 |
version | string | 是 | APP 版本号 |
client\_type | string | 是 | 客户端类型 |
sign | string | 是 | Base64 签名 |
响应示例
成功:
{
"status": "success",
"code": 200,
"message": "登录成功",
"data": {
"line_info": {},
"route_info": {}
}
}
失败:
{
"status": "error",
"code": 401,
"message": "密码错误"
}
3. 手机号+验证码登录
描述:验证码快捷登录
请求参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
phone | string | 是 | 手机号 |
code | string | 是 | 验证码 |
version | string | 是 | APP 版本号 |
client\_type | string | 是 | 客户端类型 |
sign | string | 是 | Base64 签名 |
响应示例
{
"status": "success",
"code": 200,
"message": "登录成功",
"data": {
"line_info": {},
"route_info": {}
}
}
4. 获取验证码
描述:向用户手机发送登录验证码
请求参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
phone | string | 是 | 手机号 |
version | string | 是 | APP 版本号 |
client\_type | string | 是 | 客户端类型 |
sign | string | 是 | Base64 签名 |
响应示例
{
"status": "success",
"code": 200,
"message": "验证码已发送",
"data": {
"code": "123456"
}
}
5. 修改密码
描述:修改用户登录密码
请求参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
phone | string | 是 | 手机号 |
old\_password | string | 是 | 原密码 |
new\_password | string | 是 | 新密码 |
version | string | 是 | APP 版本号 |
client\_type | string | 是 | 客户端类型 |
sign | string | 是 | Base64 签名 |
响应示例
{
"status": "success",
"code": 200,
"message": "密码修改成功"
}