接口调用说明
## 重要说明
>w ◆ 当接口返回错误码 `code` **不为零** 表明接口调用出错,此时建议弹窗错误信息 `msg` 字段提示用户;
◆ **请求时 header 中 content-type 必须设置为 ++application/x-www-form-urlencoded++**
◆ **所有接口** 必须带上平台标识字段 **platform** 如 **mp-alipay**
## 前端GIT仓库地址
[https://git.code.tencent.com/damerick/uniapp-e7rent](https://git.code.tencent.com/damerick/uniapp-e7rent)
## 接口域名
|环境|域名|
|-|-|-|-|
|测试环境|`暂无`|
|正式环境|`https://api.e7rent.com/`|
## 平台代号
|代号|平台|
|-|-|-|-|
|mp-alipay|支付宝小程序|
|mp-toutiao|抖音小程序|
|mp-weixin|微信小程序|
## 常见错误码
|错误码|备注|
|:-:|-|-|-|
|1|一般错误,详见 `msg` 字段|
|999|TOKEN校验失败/登录失败|
|==500==|系统错误|
|==1054==|数据库错误|
>d code===500 或 1054== 或 code=1, msg 为英文代码的,请提供返回的 **msg** 给后端排查问题:blush:
#### 接口请求成功一般返回:
```json
{
"code": 0, //错误码=0
"msg": "ok", //成功为ok
"data": "返回的数据内容" //数据类型依据情境可能为 string/array/boolean/object 等
}
```
#### 接口请求失败一般返回:
```json
{
"code": 1, //错误码>0,一般=1,有特殊定义的错误码除外,如999
"msg": "数据校验失败" //错误信息,一般会提示失败原因
}
```
>d ⚠ **关于TOKEN**
◆ **没有过期时间**,在同一设备一次登录永久有效;
◆ 通过登录接口生成,获得后存储于本地,**登录成功后每个API请求都带上此字段;**
◆ 如:身份校验失败时(帐号在其他设备登录),需要登录的接口将返回 `code`=999,如下所示,此时前端应退出登录
```json
{
"code": 999,
"msg": "鉴权失败"
}
```
>d ⚠ **关于删除操作**
◆ 所有的删除操作在调用API前,要弹出确认弹窗给用户选择,用户操作确认后再调用API。
>i **关于分页:**
◆ 所有列表页面的分页都是 **【15条/页】**;
◆ page参数可以不传,默认=1;
◆ 前端列表建议做成无限下拉,判断如果拿到的list条数<15,则显然没有下一页;当一页条数=15时,下拉到底部自动请求page+1,此时若返回 code=1 则表明“没有更多了”。