接口说明

展开

接口说明

**基础URL**
PC管理后台接口基础URL：你的域名/adminapi
小程序接口基础URL：你的域名/shopapi

**请求方式**
get请求：主要用于获取数据、获取下载链接
post请求：主要用于添加数据、更新数据、删除数据

**所有接口在请求的时候，某些参数都是固定名称，在接口文档中不会再说明需要此参数。**
**常用**

| 参数名称 |数据类型 | 缺少值|说明|
| ------ | ------ | ------ |------ |
| token | string| |token为验证令牌，所有需要登录接口必填。token值必须放在Headers(请求头)。|
| version | string| |version为客户端版本，所有接口都需要传。version值必须放在Headers(请求头)。|

列表

| 参数名称 |数据类型 | 缺少值|说明|
| ------ | ------ | ------ |------ |
| page_no | int|1| 所有列表接口固定参数，此参数会页码。|
| page_size |int |25| 所有列表接口必固定参数，此参数为每页数量。|
| page_type |int |0| 当page_type等于1的时候，不分页，返回列表所有数据或导出所有数据（可能被系统限制，一般够用）|
| order_by |  string|"desc"|排序方式，"desc"为降序排列,"asc"为正序排列。|
| field | string||排序字段的名称，必须与列表字段名称一致。|
| start_time | string||开始时间，时间格式为"2021-07-06 00:00:00"|
| end_time | string||结束时间，时间格式为"2021-07-06 23:59:59"|
| start | int|| 开始值 |
| end | int||结束值|

列表导出

| 参数名称 |数据类型 | 缺少值|说明|
| ------ | ------ | ------ |------ |
| export | string||excel等于1时，获取导出信息，等于2时，获取导出文件下载链接|
| page_type | int|0|导出类型 0-全部导出 1-按页码导出|
| page_size | int|25|每页数量|
| page_start | int|1|导出范围页码开始值|
| page_end | int|200|导出范围页码结束值|
| file_name |string|列表默认名称|导出下载文件的名称|

# 响应
## 返回值通用格式
### 通用格式
```
{
    "code": 0,
    "show": 0,
    "msg": "",
    "data": {
    }
}
```
| 字段名称|数据类型 |说明|
| ------ | ------ | ------ |
| code |int | 1-操作成功；0-操作失败； -1重定向到登录页；2-打开新的页面(data.url)|
| show |int | 0-不提示msg内容；1-提示msg内容 ；|
| msg | string| 提示语|
| data | object | 数据 |
### 数据列表
```
{
    "code": 1,
    "show": 0,
    "msg": "",
    "data": {
        "lists": [
            {
                "id": 3,
                "name": "3运营人员3",
                "account": "1",
                "role_id": 2,
                "create_time": "2020-12-20 15:44:39",
                "disable": 0,
                "login_time": "2021-07-07 11:35:43",
                "login_ip": "1.119.194.226",
                "multipoint_login": 1,
                "disable_desc": "正常",
                "role_name": "运营人"
            },
            {
                "id": 2,
                "name": "运营人员",
                "account": "test",
                "role_id": 2,
                "create_time": "2020-12-20 15:44:39",
                "disable": 0,
                "login_time": "2021-07-29 15:43:05",
                "login_ip": "1.119.194.226",
                "multipoint_login": 1,
                "disable_desc": "正常",
                "role_name": "运营人"
            },
            {
                "id": 1,
                "name": "账号1",
                "account": "admin",
                "role_id": 1,
                "create_time": "1970-01-14 04:38:31",
                "disable": 0,
                "login_time": "2021-07-27 16:41:49",
                "login_ip": "113.110.226.198",
                "multipoint_login": 0,
                "disable_desc": "正常",
                "role_name": "系统超级管理"
            }
        ],
        "count": 3,
        "page_no": 1,
        "page_size": 25,
        "extend": []
    }
}
```

### 列表导出信息
```{
    "code": 1,
    "show": 0,
    "msg": "",
    "data": {
        "count": 3,
        "page_size": 25,
        "sum_page": 1,
        "max_page": 1000,
        "all_max_size": 25000,
        "page_start": 1,
        "page_end": 1,
        "file_name": "管理员列表"
    }
``` 
| 字段名称|数据类型 |说明|
| ------ | ------ | ------ |
| data | object | 数据 |
| - count | int | 所有数据记录数 |
| - page_size | int | 每页记录数 |
| - sum_page| int | 一共多少页 |
| - max_page | int | 最多导出记录数 |
| - page_start | int | 导出范围页码开始值 |
| - page_end| int|导出范围页码结束值|
| - file_name| string|列表导出下载文件名|

### 列表导出

``` 
{
    "code": 2,
    "show": 0,
    "msg": "",
    "data": {
        "url": "http://www.likeshopb2cv3.localhost/index/download/export.html?file=5e372043e219f021a2ca899155425e1c1627551184"
    }
}
```
| 字段名称|数据类型 |说明|
| ------ | ------ | ------ |
| data | object | 数据 |
| - url | string | 到文件下载链接，前端打开新链接即可下载 |