API说明
# API说明
### 接口请求地址
```
测试环境:
API:
http://zbapi.ybhzkj.com/
SERVICE:
http://zbservice.ybhzkj.com
后台地址:
http://zbadmin.ybhzkj.com/admin.php/Index/index.html
现网环境:
API:
http://api.ybdas.com/
SERVICE:
http://service.ybdas.com/
admin地址:
http://admin.ybdas.com/admin.php/Index/index.html
```
### 通用输入参数
#### Header
|参数名称|是否必传|参数说明|参数示例|
|-|-|-|-|
|token| 是 | 登录令牌 | |
|auth-key | 是 | 参数校验秘钥 | |
#### 通用参数 【可以跟在 url后以get 的方式传输通用字段】
|参数名称|是否必传|参数说明|参数示例|
|-|-|-|-|
|times| 是 | 当前时间戳(秒级) | |
|random_num| 是 | 随机数字段 4 位数 | |
|random_key| 是 | 随机秘钥 将times 和 random_num 两个参数 转为字符串 以 _ 链接进行md5后的参数(random_key) | [ randomKey = md5(times + '_' + randomNum) ] |
|version| 是 | 当前版本号 | |
|client| 是 | 安卓 1 ios 2 web 3 | |
|imei| 是 | 安卓 imei 标识 【ios传空字符串】 | |
|uuid| 是 | 客户端生成唯一标识 | |
|brand| 是 | 手机品牌 | |
|model| 是 | 手机型号 | |
|longitude| 是 | 经度 | |
|latitude| 是 | 纬度 | |
|app_name| 是 | 应用名称 | |
|channel| 是 | 渠道号| |
```
uuid:
https://www.jianshu.com/p/1011c872458d
https://blog.csdn.net/lgfun/article/details/107788694
鉴于UUID每次获取的结果不一致 需要在首次获取活做外部存储保存该标识
或者有接入第三方的话,第三方会提供一个不会变的uuid,比如友盟
```
### 通用返回格式
```
{
"status": 1,
"data": {},
"message": "成功",
"code": 0
}
```
### 分页数据返回格式
```
{
"status": 1,
"data": {
"total": 2,
"per_page": 10,
"current_page": 1,
"last_page": 1,
"data": [
]
},
"message": "",
"code": 0
}
```
#### 返回值说明
|字段名|类型|说明|
|-|-|-|
|status|int|请求状态码 1 成功 0 失败|
|data|array|返回数据|
|message |string |提示消息|
|code|int|错误 码 (在特定场景会以错误码形式返回具体错误)|
#### 分页参数说明
|字段名| 类型 | 说明|
|-|-|-|
|total| int |总条数|
|per_page| int | 每页的条数 |
|current_page| int |当前页码|
|last_page| int | 当前页码 |
|data | list | 列表数据 |
```
分页方法:
参数中 传 page = N1 N1 为页码
page_size = N2 N2 为每页长度
```
#### 错误码
|错误码|说明|其他|
|-|-|-|
|901|请登录||
|902|token/ 登录失效||
|801|参数合法性校验失败 (auth-key)||
|811|auth-key 校验为空||
|821|有必传参数为空||
|700|请求频繁||