1_base.md 4.0 KB

1 全局控制器

1.1 全局配置

全局参数如无特殊说明,所有请求和响应都是以下格式;其他非全局参数如无特殊说明,响应参数均为data参数子键内容。

环境 地址
本机环境 http://api.anran.leo/v1

列表类型返回参数

参数 类型 描述
currentPage int 当前页数
list json 列表数据
pageSize int 分页大小
pagination json 分页数据
startNum int 开始页码
totalCount string 总数据
totalPages int 总页数

1.2 网站配置

用于获取网站配置

请求地址

环境 方法 路径
本机环境 GET /site/config

响应参数

参数 类型 描述
siteClose bool 站点是否关闭
siteCloseInfo string 如果关闭,则返回关闭原因
siteTitle string 如果开启,则返回网站名称

1.3 登录

用于登录系统

请求地址

环境 方法 路径
本机环境 POST /oauth/login

请求参数

参数 类型 是否必填 最大长度 描述 示例
userName string 32 用户名 tester001
password string 32 密码 111111
clientid string 32 设备id(app需提供设备id)

登录成功响应参数

参数 类型 描述
accessToken string
accessTokenExpiresIn string
accessTokenUpdateAt string
refreshToken string
refreshTokenExpiresIn string
refreshTokenUpdateAt string

登录失败响应参数

参数 类型 描述
code string
message string 提示信息
name string
status string
type string

1.4 获取刷新Token

用于获取刷新Token

请求地址

环境 方法 路径
本机环境 GET /oauth/refresh-token

请求参数

参数 类型 是否必填 最大长度 描述 示例
refresh-token string 32 刷新Token efa60b3f3c

获取成功响应参数

参数 类型 描述
accessToken string
accessTokenExpiresIn string
accessTokenUpdateAt string
refreshToken string
refreshTokenExpiresIn string
refreshTokenUpdateAt string

获取失败响应参数

参数 类型 描述
code string
message string 提示信息
name string
status string
type string

1.5 广告

用于返回系统的广告

请求地址

环境 方法 路径
本机环境 GET /site/ad

请求参数

参数 类型 是否必填 最大长度 描述 示例
lid string 32 广告位id 7EFF6260A16C3CC7E053693418AC03E4

响应参数

参数 类型 描述
ID string ID
IMAGE string 图片地址
LID string 广告位ID
TITLE string 标题
CONTENT string 内容
TYPE string 类型1幻灯2图片

1.6 移动版基础信息

用于返回我的界面信息

请求地址

环境 方法 路径
本机环境 GET /site/mobile-base-info

请求参数

参数 类型 是否必填 最大长度 描述 示例

响应参数

参数 类型 描述
decLevels json 所有报单级别
empLevels json 所有聘级
daysDiff int 时间差
shopWalletType json 所有钱包类型

1.7 我的界面信息

用于返回我的界面信息

请求地址

环境 方法 路径
本机环境 GET /dashboard/my-index

请求参数

参数 类型 是否必填 最大长度 描述 示例

响应参数

参数 类型 描述
nowTime string 当前时间
reConsumePool json 复销信息,reConsumeTimes复销可用月份,toDate复销截止日期,toRechargeDate最迟充值日期,toRechargeTime最迟充值时间,toTime复销截止时间,unusedMonth复销剩余月份,unusedPV复销余额,isPass是否合格
empLv string 聘级ID
empLvName string 聘级中文