易试驾 APP 1.0 接口文档

易试驾 api iOS Android 1.0

一、通用约定

1.0 通用接口

1.0.1 上传图片

通用上传文件服务

请求URL

POST
/upload

请求参数

• token
• file : 文件

响应

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

• url : [string] 文件的访问URL

1.1 通用请求字段

1.1.1 鉴权字段

• token : [string] 登录后获取的 token 信息

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 用户信息

{
    id: 123,
    nickname: 'xiaobaitu',
    avatar: 'http://img1.imgtn.bdimg.com/it/u=1477579747,1739345058&fm=23&gp=0.jpg',
    cell: '15801379137',
    points: 1000,
    status:1
}

• id: [int] 用户ID
• nickname: [string] 用户昵称
• avatar: [string] 头像图片地址
• cell: [string] 用户手机号
• points: [int] 积分
• status:[int]用户状态：1:正常 2:受处罚中

1.3.2 坐标信息

{
    lon: 142.32323232,
    lat: 39.232400123
}

• lon: [float] 经度
• lat: [float] 纬度

1.3.3 4S店信息

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

• id: [int] 4S店 ID
• name: [string] 4S店名称
• addr: [string] 地址
• coor: [object] 经纬度坐标
  
  • lon: [float] 经度
  • lat: [float] 纬度
• dis: [float] 距离用户的距离，单位为米（请求时必须携带用户坐标）
• logo: [string] 4S 店 logo 图片
• pic : [string] 4S 店介绍图片
• desc : [string] 简介
• tel : [string] 客服电话
• contactor : [string] 联系人
• cell : [string] 联系人手机
• worktime : [int]开始工作时间的时间戳，比如9：00,那就是60*60*9
• closetime : [int] 关门时间,给是为时间戳，相对今天0：0的秒数
• offdays : [string] 不工作时间戳,使用逗号分开，要从小到大顺序排列
• remark : [string] 特殊说明
• maxRange:[int]最大接送公里范围

1.3.4 车品牌信息

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

• id: [int] 车品牌 ID
• brand: [string] 名称
• logo: [string] 车标

1.3.5 车系信息

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

• id: [int] 车系ID
• series: [string] 车系
• cityName : [string] 城市名称
• thumbnailImg: [string] 缩略图 70x50
• bigImg: [string] 大图320x150
• price : [float] 车型单价

1.3.6 车型信息

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

• id: [int] 车型ID
• spec: [string] 显示名称
• powerType: [int] 1:汽油（默认） 2:电力 3:混合动力

1.3.7 车辆信息（完整）

{
    id: 1,
    spec: '2012款 2.0t 手动',
    powerType: 1
    brand: '奥迪',
    series: 'A6L',
    thumbnailImg: 'http://...',
    bigImg: 'http://...',
    price: 280,
    specId:111
}

• id: [int] 车系ID
• spec: [string] 显示名称
• powerType: [int] 1:汽油（默认） 2:电力 3:混合动力
• brand: [string] 名称
• series: [string] 车系
• thumbnailImg: [string] 缩略图 70x50
• bigImg: [string] 大图320x150
• specId: [int] 车型ID

1.3.8 车系下所有车型信息

{
    id: 1,
    brand: '奥迪',
    series: 'A6L',
    thumbnailImg: 'http://...',
    bigImg: 'http://...',
    price: 280
    spec:[
        ‘@车型信息’
        ]
    },
}

• id: [int] 车型ID
• brand: [string] 名称
• series: [string] 车系
• thumbnailImg: [string] 缩略图 70x50
• bigImg: [string] 大图320x150
• spec: [object] 车型信息

1.3.9 订单信息

订单状态

• 1: 待服务
• 2: 已取消
• 3: 已完成

订单信息

{
    id: 1,
    sn: 201539430493,
    4S: {
        '@4S店信息'
    },
    car: {
        brand:'@车品牌信息',
        series:'@车系信息',
        spec:'@车型信息'
    },
    status: 1,
    date: {
        start: 1231321212,
        end: 12313213212
    },
    from: {
        addr: '理想国际大厦',
        fullAddr: '北京市海淀区理想国际大厦'
        coor: {
            '@坐标信息'
        }
    },
    comment: {
        date: 1429549593193,
        score: 4,
        isComment:0
    },
    price: 200,
    type: 1,
    createdDate: 1429549593193,
    payDate: 1429549594193,
    cancelDate: 1429549593193,
    completeDate: 1429549593193
}

• id: [int] 订单ID
• sn: [string] 订单编号
• 4S: [object] 4S 店信息，参考4S店信息(付费则没有4S)
• car: [object] 车型信息，参考车型信息
• status: [int] 订单状态
  
  • 1: 待服务
  • 2: 已取消
  • 3: 已完成
• date: [object] 订单时间段
  
  • start: [int] 时间段开始
  • end: [int] 时间段结束
• from: [object] 试驾起始位置
  
  • addr: [string] 起始地址
  • fullAddr: [string] 起始地址全称
  • coor: [object] 起始位置坐标
• comment: [object] 评论
  
  • date: [int] 评论日期
  • score: [int] 评分
  • isComment: [bool] 是否已评价
• createdDate: [int] 订单创建日期
• cancelDate: [int] 订单取消日期
• completeDate: [int] 订单完成日期
• type : [int] 订单类型，1 - 免费，2 - 收费

1.4.0 首页板块

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

• id: [int] 板块ID
• type: [int] 1:免费全部 3:电车 4:某品牌专版 2:付费
• title: [string] 板块名称
• desc: [string] 板块描述
• pic: [string] 图片
• brandId : 当type == 4的时候，server需要关注这个

1.4.1 积分规则

{
    id: 1,
    reason: 1,
    points: 100,
}

• id: [int] 积分规则ID
• reason: [int] 1:分享增加 2:评价增加 3:订单完成增加
• points: [int] 增加积分数

1.4.2 版本信息

{
    version:'1.0.0',
    url: 'http://www.baidu.com',
    description: '小米市场',
    from:'iOS_91'
}

• version: [string] 版本号
• url: [string] 升级地址
• description: [string] 版本描述
• from: [string] 渠道值

二、API 接口

【线上base url】http://101.200.233.119/Api/V1/

2.1 用户信息

2.1.1 获取验证码

请求URL

POST
/login/verifycode

请求参数

• phoneNumber: [string]接收验证码的手机号

响应

{
    errorCode: 0,
    data: {
    }
}

2.1.2 登录

请求URL

POST
/login

请求参数

• phoneNumber: 手机号
• verifyCode: 验证码
• deviceId: 设备 ID

响应

{
    errorCode: 0,
    data: {
        token: '19201931210e'
    }
}

• token : [string] 登录成功后的token，后续数据接口均需携带该参数

2.1.3 登出

请求URL

POST
/loginout

请求参数

• token

响应

{
    errorCode: 0,
    data: {
    }
}

2.1.4 获取个人资料

请求URL

POST
/me

请求参数

• token

响应

{
    errorCode: 0,
    data: {
        '&用户信息'
    }
}

2.1.5 更改个人资料

请求URL

POST
/me/update

请求参数

• token
• avatar : [string]图片url
• nickname : [string]用户昵称

响应

{
    errorCode: 0,
    data: {
        '@用户信息'
    }
}

2.1.6 个人中心反馈

请求URL

POST
/feedback

请求参数

• token
• content : 反馈内容

响应

{
    errorCode: 0,
    data: {
    }
}

2.2 积分

2.2.1 获取积分排行榜列表

请求URL

POST
/ranking

请求参数

无

响应

{
    errorCode: 0,
    data: {
        list: [
            '@用户信息'
        ]
    }
}

2.2.2 分享成功

请求URL

POST
user/share

请求参数

• token
• platform : [int] 分享平台类型:
  1:微博 2:朋友圈 3:微信好友 4:QQ

响应

{
    errorCode: 0,
    data: {
    }
}

2.2.3 积分规则列表

请求URL

POST
rule/point

请求参数

响应

{
    errorCode: 0,
    data: {
     list: [
            '@积分规则'
        ]
    }
}

2.3 订单

2.3.1 获取订单列表

请求URL

POST
/orders

请求参数

• token
• status : 订单状态，传 0 则返回全部订单

响应

{
    errorCode: 0,
    data: {
        list: [
            '@订单信息'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

2.3.2 获取待评价订单列表

请求URL

POST
/orders/ready

请求参数

• token

响应

{
    errorCode: 0,
    data: {
        list: [
            '@订单信息'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

2.3.4 获取订单详情

请求URL

POST
/order/detail

请求参数

• token
• orderId: [int] 订单ID

响应

{
    errorCode: 0,
    data: {
        '@订单信息'
    }
}

2.3.4 修改订单状态

请求URL

POST
order/status

请求参数

• token
• orderId: [int] 订单ID
• status:[int]要修改成结果的状态，取消订单传2 完成订单传3

响应

{
    errorCode: 0,
    data: {
        id:123
    }
}

• id : [int] 订单 ID

2.3.5 订单评价

请求URL

POST
/order/comment

请求参数

• token
• orderId: [int] 订单ID
• score: [int] 评分

响应

{
    errorCode: 0,
    data: {
    }
}

2.4 广告

2.4.1 获取顶部 Banner 广告列表

请求URL

POST
/ad/banners

请求参数

• cityName : [string] 所在城市名称

响应

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

• pic : [string] Banner 图片地址
• link : [string] 链接
• title : [string] 广告标题
• desc : [string] 广告描述

2.5 汽车数据

2.5.1 品牌列表（搜索品牌）

请求URL

POST
/car/brands

请求参数

• keyword : [string] 搜索关键词，留空则返回全部品牌
• cityName : [string] 所在城市名【必填】
• platedId : [int]首页板块id【必填】

响应

{
    "errorCode": 0,
    "data": {
        "list": [
            {
                "letter": "A",
                "detail": [
                    {
                        ‘@品牌信息’
                    }
                ]
            },
            {
                "letter": "B",
                "detail": [
                    {
                        "id": 3,
                        "logo": "http://img.autoimg.cn/logo/brand/50/130713021464992840.jpg",
                        "brand": "保时捷"
                    }
                ]
            }
        ]
    }
}

• id : [int] 品牌ID
• letter : [string] 字母
• logo : [string] 品牌图片
• brand : [string] 品牌名称

2.5.2 获取车系车型列表

请求URL

POST
/car/series

请求参数

• brandId : [int] 品牌ID【必填】付费传0或者ID
• cityName : [string]城市名称【必填】
• pageNum: [int]【必填】
• pageSize:[int]【必填】
• type : [int]，1 - 免费，2 - 收费【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
            '@车系下所有车型信息'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

2.6 预约

2.6.1 提交预约

请求URL

POST
/order/create

请求参数

• token【必填】
• seriesId : [int] 车系 ID【必填】
• specId : [int] 车型 ID, 任意车型请传0或不传【必填】
• fromFullAddr : [string] 接送位置全名称【必填】
• fromAddr : [string] 接送位置名称【必填】
• fromLon : [float] 接送位置经度【必填】
• fromLat : [float] 接送位置纬度【必填】
• shopId : [int] 4S店 ID【必填】
• start : [int] 预约start时间戳【必填】
• type : [int] 订单类型，1 - 免费，2 - 收费

响应

{
    errorCode: 0,
    data: {
    }
}

• increasedPoints: [int] 增加的积分

2.6.2 获取4S店列表

请求URL

POST
/shops

请求参数

• cityName : [str] 所在城市名称【必填】
• seriesId : [int] 车系 ID【必填】
• specId : [int] 车型 ID, 任意车型请传0或不传【必填】
• locationLon : [float] 当前位置经度，定位不到不传或者传0【选填】
• locationLat : [float] 当前位置纬度，定位不到不传或者传0【选填】
• addr : [string] 接送地址【选填】
• pageNum: [int]【必填】
• pageSize:[int]【必填】
• type : [int] 1 - 免费，2 - 付费
  响应

{
    errorCode: 0,
    data: {
        list: [
            '@4S店信息'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

2.6.3 获取试驾时间列表

请求URL

POST
/shops/times

请求参数

• seriesId : [int] 车系 ID【必填】
• specId : [int] 车型 ID, 任意车型请传0或不传【必填】
• shopId : [int] 4S 店ID,【必填】
• type : [int] 订单类型，1 - 免费，2 - 收费【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
            {
                date: 13434343343,
                day: [
                    {
                        start: 1324232323，
                        end: 12313213212,
                        available: 1
                    }
                ],
            }
        ]
    }
}

list 中对象的 key 为指定的日期(天)，value 为当天的时间段

• date : [int] 某一天的日期时间戳
• day : [object] 一天的时间段
  
  • start : [int] 预约起始时间
  • end : [int] 预约结束时间
  • avaiable : [int] 是否可预约 0 - 否，1 - 可

2.7 城市信息

获取已开通服务城市列表

请求URL

POST
/cities

请求参数

无

响应

{
    errorCode: 0,
    data: {
        version: '123',
        list: [
            {
                id: 1,
                cid: '001',
                name: '北京',
                plate:'@首页板块',
                spaceTime:3600
            }
        ]
    }
}

• version : [string] 数据版本号，供 APP 更新本地缓存对比
• id : [int] 城市 ID
• cid : [string] 城市编号
• name : [string] 城市名称
• plate:@首页板块
• spaceTime:时间戳

2.8 升级

请求URL

POST
/updateVersion

请求参数

• from:渠道值 （同“四、渠道号“）

响应

{
    errorCode: 0,
    data: {
        '@版本信息'
    }
}

2.9 首页

2.9.1 热门车型列表（免费）

请求URL

POST

请求参数

• cityName : [string]城市名称【必填】
• pageNum: [int]【必填】
• pageSize:[int]【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
                 { car:'@车辆信息（完整）',
                   is_full:0
                 }
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

• car : [object] '@车辆信息（完整）'
• is_full : [int] 是否约满：0没有约满 1约满

2.9.2 车型详情（免费）

请求URL

POST
/model/detail
请求参数

• id : [int]车型名称【必填】

响应

{
    errorCode: 0,
    data: {
        list: {
                '@车辆信息（完整）'
        }
    }
}

三、其他URL

3.1 试驾协议

H5 URL

/policy/user

3.2 隐私协议

H5 URL

http://www.51eshijia.com/policy/privacy

3.3 法律条款

H5 URL

/policy/law

3.4 分享协议

H5 URL

/app

3.5 App下载地址

H5 URL

/app

四、渠道号

【安卓市场】

【iOS苹果】