@lina 2016-05-20T03:45:46.000000Z 字数 7613 阅读 327

易试驾 1.0后台接口文档

api 后台 1.0 易试驾

一、通用约定

1.1 通用请求字段

1.1.1 鉴权字段

session : [string] 登录后获取登录认证

1.2 通用响应字段

1.2.1 状态字段

errorCode: [int] 服务器状态码，0 为正常状态，异常状态待定。

errorMessage：[string] 错误信息，但 errorCode 不为 0 时返回

1.2.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.2.3 分页字段

pageInfo: [object] 分页信息，当返回数组数据时会携带该字段

currentPage: [int] 当前页码

totalPage: [int] 总页数

pageSize: [int] 每页数量

示例

{
    errorCode: 0,
    data: {
        key: value,
        list: [{
            key: value
        }],
        pageInfo {
        }
    }
}

1.3 通用接口

1.3.1 上传图片

通用上传文件服务

请求URL

POST
/upload

请求参数

session

file : 文件

响应

{
    errorCode: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.4 通用数据结构

1.4.1 后台用户信息

{
    id: 123,
    name: 'xiaobaitu',
    password: '1234'
    role:0
}

id: [int] 用户ID

name: [string] 用户登录名称

role: [int] 0:超级管理员 1:4S店 2:易试驾业务员

1.4.2 坐标信息

{
    lon: 142.32323232,
    lat: 39.232400123
}

lon: [float] 经度

lat: [float] 纬度

1.4.3 4S店基本信息

{
    id: 1,
    name: '百得利奥迪中心',
    addr: '北京市经济技术开发区东环北路1号1',
    coor: {
        '@坐标信息'
    },
    pic: 'http://',
    tel: '010-83829389',
    contactor:'Hallen',
    cell:'13811849645',
    worktime:91000
    closetime:99000
    offdays:'1324232323,1324232324,1324232325',
    cityName: '北京'
    keyword:'audi',
    remark:'特殊说明'
}

id: [int] 4S店 ID

name: [string] 4S店名称

addr: [string] 地址

coor: [object] 经纬度坐标

lon: [float] 经度

lat: [float] 纬度

pic : [string] 4S 店介绍图片

tel : [string] 客服电话

contactor : [string] 联系人

cell : [string] 联系人手机

worktime : [int]开始工作时间的时间戳，比如9：00,那就是60*60*9

closetime : [int] 关门时间,给是为时间戳，相对今天0：0的秒数

offdays : [string] 不工作时间戳,使用逗号分开，要从小到大顺序排列

cityName : [string] 所属城市名称

keyword : [string] 关键字

remark : [string] 特殊说明

1.4.4 车品牌信息

{
    id: 1,
    brand: '奥迪',
    logo: 'http://...'
}

id: [int] 车品牌 ID

brand: [string] 名称

logo: [string] 车标

1.4.5 车系信息

{
    id: 1,
    series: 'A6L',
    cityName: '北京'
    thumbnailImg: 'http://...',
    bigImg: 'http://...'
}

id: [int] 车系ID

series: [string] 车系

cityName : [string] 城市名称【必填】

thumbnailImg: [string] 缩略图 70x50

bigImg: [string] 大图320x150

1.4.6 车型信息

{
    id: 1,
    spec: '2012款 2.0t 手动',
    powerType: 1
}

id: [int] 车型ID

spec: [string] 显示名称

powerType: [int] 1:汽油（默认） 2:电力 3:混合动力

1.4.7 试驾车信息

{
    id: 1,
    brand: {
        '@车品牌信息'
    },
    series: {
        '@车系信息'
    },
    spec: {
      '@车型信息'
    },
    num:5
}

id: [int] 试驾车ID

brand: [object] @车品牌信息

series: [object] @车系信息

spec: [object] @车型信息

num : [int] 车辆数目

1.4.8 广告信息

{
        pic: 'https://ss0.bdstatic.com/70cFuHSh_Q1YnxGkpoWK1HF6hhy/it/u=1722966551,3293303547&fm=116&gp=0.jpg',
        link: '#abc',
        title: '试驾特斯拉Model S P85D',
        desc: '来自未来的车',
        orderNum:0,
        cityName: '北京'
}

pic : [string] Banner 图片地址

link : [string] 链接

title : [string] 广告标题

desc : [string] 广告描述

orderNum : [int] 排序号，用于表示广告的顺序

cityName : [string] 所在城市名称

1.4.9 首页板块

{
id: 1,
type: 0,
title: '免费试驾',
desc: '上班自由',
pic: 'http://...',
brandId: '123'
}


> 
* `id`: [int] 板块ID
* `type`: [int] 0:免费全部 1:电车 2:某品牌专版
* `title`: [string] 板块名称
* `desc`: [string] 板块描述
* `brandId` : 当type == 2的时候，server需要关注这个
* `pic`: [string] 图片192 * 134
# 二、API 接口
## 2.1 城市管理
#### 2.1.1 城市开通和关闭//城市里有服务，付费免费分别判断
#### 2.1.2 获取已开通服务城市列表
请求URL
> 
POST
请求参数
> 
无
响应
```javascript
{
    errorCode: 0,
    data: {
        list: [
            {
                id: 1,
                name: '北京',
                free: 1,
                charge: 1
            }
        ]
    }
}
<div class="md-section-divider"></div>

id : [int] 城市 ID

name : [string] 城市名称

free : [int] 免费服务是否开通，0 - 未开通，1 - 开通

charge : [int] 收费服务是否开通，0 - 未开通，1 - 开通

2.2 4S店管理

2.2.1 + 新增4S店基本信息

请求URL

POST

请求参数

name: [string] 4S店名称【必填】

addr: [string] 地址【必填】

coor: [object] 经纬度坐标【必填】

lon: [float] 经度

lat: [float] 纬度

pic : [string] 4S 店介绍图片

tel : [string] 客服电话【必填】

contactor : [string] 联系人【必填】

cell : [string] 联系人手机【必填】

worktime : [int]开始工作时间的时间戳，比如9：00,那就是60*60*9【必填】

closetime : [int] 关门时间,给是为时间戳，相对今天0：0的秒数【必填】

offdays : [string] 不工作时间戳,使用逗号分开，要从小到大顺序排列

cityName : [string] 所属城市名称【必填】

keyword : [string] 关键字

remark : [string] 特殊说明

响应

{
    errorCode: 0,
    data: {
        ‘@4S店基本信息’
    }
}
<div class="md-section-divider"></div>

id : [int] 4S店 ID

2.2.2 M 修改4S店基本信息

请求URL

POST

请求参数

id: [int] 4S店 ID【必填】

name: [string] 4S店名称【必填】

addr: [string] 地址【必填】

coor: [object] 经纬度坐标【必填】

lon: [float] 经度

lat: [float] 纬度

pic : [string] 4S 店介绍图片

tel : [string] 客服电话【必填】

contactor : [string] 联系人【必填】

cell : [string] 联系人手机【必填】

worktime : [int]开始工作时间的时间戳，比如9：00,那就是60*60*9【必填】

closetime : [int] 关门时间,给是为时间戳，相对今天0：0的秒数【必填】

offdays : [string] 不工作时间戳,使用逗号分开，要从小到大顺序排列

cityName : [string] 所属城市名称【必填】

keyword : [string] 关键字

remark : [string] 特殊说明

响应

{
    errorCode: 0,
    data: {
        '@4S店基本信息'
    }
}
<div class="md-section-divider"></div>

2.2.3 D 删除4S店

请求URL

POST

请求参数

id: [int] 4S店 ID【必填】

响应

{
    errorCode: 0,
    data: {
    }
}
<div class="md-section-divider"></div>

2.2.4 list 4S店列表（查询、排序）

请求URL

POST

请求参数

pageNum: [int]【必填】

pageSize:[int]【必填】

search:{
keyword:'XXX4S店' //可以匹配name、addr、tel、cell、contactor、keyword、remark
}

sortFieldName:[string]排序字段，比如按照地址排序则传addr

sortOrder:[string] dec:降序 asc:升序

响应

{
    errorCode: 0,
    data: {
         list: [
            {
                '@4S店基本信息'
            }
        ]
    }
}
<div class="md-section-divider"></div>

2.2.5 get 单个4S店详情

请求URL

POST

请求参数

id: [int] 4S店 ID【必填】

响应

{
    errorCode: 0,
    data: {
        '@4S店基本信息'
    }
}
<div class="md-section-divider"></div>

2.3 试驾车管理

2.3.1 + 新增试驾车信息

请求URL

POST

请求参数

shopId: [string] 4S ID 或者其他合作店ID【必填】

brandId: [int] 车品牌Id【必填】

seriesId: [int] 车系Id【必填】

specId: [int] 车型Id【必填】

num : [int] 车辆数目【必填】

响应

{
    errorCode: 0,
    data: {
        '@试驾车信息'
    }
}
<div class="md-section-divider"></div>

id : [int] 试驾车 ID

2.3.2 M 修改试驾车信息

请求URL

POST

请求参数

id: [int] 试驾车 ID【必填】

shopId: [string] 4S ID 或者其他合作店ID【必填】

brandId: [int] 车品牌Id【必填】

seriesId: [int] 车系Id【必填】

specId: [int] 车型Id【必填】

num : [int] 车辆数目【必填】

响应

{
    errorCode: 0,
    data: {
        '@试驾车信息'
    }
}
<div class="md-section-divider"></div>

2.3.3 D 删除试驾车

请求URL

POST

请求参数

id: [int] 试驾车 ID【必填】

响应

{
    errorCode: 0,
    data: {
    }
}
<div class="md-section-divider"></div>

2.3.4 list 试驾车列表（查询、排序）

请求URL

POST

请求参数

pageNum: [int]【必填】

pageSize:[int]【必填】

search:{
keyword:'奥迪' //可以匹配品牌名称、车系名称、车型名称
}

sortFieldName:[string]排序字段，比如按照地址排序则传brand、series、sepc

sortOrder:[string] dec:降序 asc:升序

shopId : [int] 4S店Id 或者其他合作店ID【必填】

响应

{
    errorCode: 0,
    data: {
         list: [
            {
                '@试驾车信息'
            }
        ]
    }
}
<div class="md-section-divider"></div>

2.2.5 get 单个试驾车详情

请求URL

POST

请求参数

id: [int] 试驾车 ID【必填】

shopId : [int] 4S店Id

响应

{
    errorCode: 0,
    data: {
        '@试驾车信息'
    }
}
<div class="md-section-divider"></div>

2.4 广告（广告位固定5个）

2.4.1 M 修改广告位信息

请求URL

POST

请求参数

id: [int] 广告 ID【必填】

pic : [string] Banner 图片地址【必填】

link : [string] 链接

title : [string] 广告标题

desc : [string] 广告描述

orderNum : [int] 排序号，用于表示广告的顺序【必填】

cityName : [string] 所在城市名称【必填】

响应

{
    errorCode: 0,
    data: {
        '@广告信息'
    }
}
<div class="md-section-divider"></div>

请求URL

POST

请求参数

cityName : [string] 所在城市名称

响应

{
    errorCode: 0,
    data: {
        list: [
            {
                '@广告信息'
            }
        ]
    }
}
<div class="md-section-divider"></div>

========================================================

2.5 汽车数据

2.5.1 + 新增车品牌

请求URL

POST

请求参数

brand: [string] 名称【必填】

logo: [string] 车标【必填】

响应

{
    errorCode: 0,
    data: {
        '@车品牌'
    }
}
<div class="md-section-divider"></div>

2.5.2 M 修改车品牌

请求URL

POST

请求参数

id: [int] 车品牌 ID 【必填】

brand: [string] 名称【必填】

logo: [string] 车标【必填】

响应

{
    errorCode: 0,
    data: {
        '@车品牌'
    }
}
<div class="md-section-divider"></div>

2.5.3 D 删除车品牌

请求URL

POST

请求参数

id: [int] 车品牌 ID【必填】

响应

{
    errorCode: 0,
    data: {
    }
}
<div class="md-section-divider"></div>

2.5.4 list 车品牌列表（查询、排序）

请求URL

POST

请求参数

pageNum: [int]【必填】

pageSize:[int]【必填】

search:{
keyword:'奥迪' //可以匹配品牌名称
}

sortFieldName:[string]排序字段，比如传brand

sortOrder:[string] dec:降序 asc:升序

响应

{
    errorCode: 0,
    data: {
         list: [
            {
                '@车品牌'
            }
        ]
    }
}
<div class="md-section-divider"></div>

2.5.5 + 新增车系

请求URL

POST

请求参数

series: [string] 车系【必填】

price : [float] 车型单价【必填】

cityName : [string] 城市名称【必填】

thumbnailImg: [string] 缩略图 70x50【必填】

bigImg: [string] 大图320x150【必填】

响应

{
    errorCode: 0,
    data: {
        '@车系'
    }
}
<div class="md-section-divider"></div>

2.5.6 M 修改车品牌

请求URL

POST

请求参数

id: [int] 车系ID【必填】

series: [string] 车系【必填】

price : [float] 车型单价【必填】

cityName : [string] 城市名称【必填】

thumbnailImg: [string] 缩略图 70x50【必填】

bigImg: [string] 大图320x150【必填】

响应

{
    errorCode: 0,
    data: {
        '@车系'
    }
}
<div class="md-section-divider"></div>

2.5.7 D 删除车品牌

请求URL

POST

请求参数

id: [int] 车系 ID【必填】

响应

{
    errorCode: 0,
    data: {
    }
}
<div class="md-section-divider"></div>

2.5.8 list 车系列表（查询、排序）

请求URL

POST

请求参数

pageNum: [int]【必填】

pageSize:[int]【必填】

search:{
keyword:'A6L' //可以匹配车系名称
}

sortFieldName:[string]排序字段，比如传series

sortOrder:[string] dec:降序 asc:升序

响应

{
    errorCode: 0,
    data: {
         list: [
            {
                '@车系'
            }
        ]
    }
}
<div class="md-section-divider"></div>

2.5.9 + 新增车型

请求URL

POST

请求参数

spec: [string] 车型名称【必填】

powerType: [int] 1:汽油（默认） 2:电力 3:混合动力【必填】

响应

{
    errorCode: 0,
    data: {
        '@车型'
    }
}
<div class="md-section-divider"></div>

2.5.10 M 修改车型

请求URL

POST

请求参数

id: [int] 车品牌 ID 【必填】

name: [string] 显示名称

powerType: [int] 1:汽油（默认） 2:电力 3:混合动力

响应

{
    errorCode: 0,
    data: {
        '@车型'
    }
}
<div class="md-section-divider"></div>

2.5.11 D 删除车型

请求URL

POST

请求参数

id: [int] 车型 ID【必填】

响应

{
    errorCode: 0,
    data: {
    }
}
<div class="md-section-divider"></div>

2.5.12 list 车型（查询、排序）

请求URL

POST

请求参数

pageNum: [int]【必填】

pageSize:[int]【必填】

search:{
keyword:'2012款' //可以匹配车型名称
}

sortFieldName:[string]排序字段，比如传sepc、powerType

sortOrder:[string] dec:降序 asc:升序

响应

{
    errorCode: 0,
    data: {
         list: [
            {
                '@车型'
            }
        ]
    }
}

易试驾 1.0后台接口文档

一、通用约定

1.1 通用请求字段

1.1.1 鉴权字段

1.2 通用响应字段

1.2.1 状态字段

1.2.2 数据字段

1.2.3 分页字段

1.3 通用接口

1.3.1 上传图片

1.4 通用数据结构

1.4.1 后台用户信息

1.4.2 坐标信息

1.4.3 4S店基本信息

1.4.4 车品牌信息

1.4.5 车系信息

1.4.6 车型信息

1.4.7 试驾车信息

1.4.8 广告信息

1.4.9 首页板块

2.2 4S店管理

2.2.1 + 新增4S店基本信息

2.2.2 M 修改4S店基本信息

2.2.3 D 删除4S店

2.2.4 list 4S店列表（查询、排序）

2.2.5 get 单个4S店详情

2.3 试驾车管理

2.3.1 + 新增试驾车信息

2.3.2 M 修改试驾车信息

2.3.3 D 删除试驾车

2.3.4 list 试驾车列表（查询、排序）

2.2.5 get 单个试驾车详情

2.4 广告（广告位固定5个）

2.4.1 M 修改广告位信息

2.4.2 获取顶部 Banner 广告列表

2.5 汽车数据

2.5.1 + 新增车品牌

2.5.2 M 修改车品牌

2.5.3 D 删除车品牌

2.5.4 list 车品牌列表（查询、排序）

2.5.5 + 新增车系

2.5.6 M 修改车品牌

2.5.7 D 删除车品牌

2.5.8 list 车系列表（查询、排序）

2.5.9 + 新增车型

2.5.10 M 修改车型

2.5.11 D 删除车型

2.5.12 list 车型（查询、排序）

内容目录