PDF《第1页》

第1页查博士 API 文档接口说明 第2页版本信息.

3 购买报告流程详细说明.4

1 购买报告接口.5 1.1 参数说明:5 1.2 购买报告接口 Code 码表:6 2. 查看订单状态接口.6 2.2 查看订单状态接口 Code 码表.7 3. 查询品牌是否支持查询.8 3.1 参数说明:8 3.2 查询是否支持查询接口 Code 码表.8 4. 查询报告详情(新版)9 4.1 参数说明:10

5 获取 Json 格式报告(新版)10 5.1 参数说明:10 5.2 获取 json 格式接口返回 Code 码表.11 5.3 json 格式样例:13

6 回调接口说明.15 6.1 参数说明:16 6.2 结果码说明:16 第3页版本信息 版本号 时间 编写人员 说明 v1.1 2016-05-20 任杰 起稿 V1.2 2016-08-05 任杰 提供 SDK,客户可以直接调用 V1.3 2016-08-25 任杰 1.新增回调功能. 2.处理 json 数据,便于接口用户解析. 3.调整接口返回的状态码以及信息描述. V1.4 2016-09-21 任杰 1.将回调结果具体化. 2.增加新版报告(json)接口. 3.增加新版报告(pc、wap 页面)接口. V1.5 2017-03-29 任杰 1.旧版报告接口下线. 2.增加购买报告流程详细说明. 3.规范文档,详细说明 json 格式. 第4页购买报告流程详细说明 1.调用购买报告接口,获取订单号. 2.如果购买报告的时候传入了回调的地址,说明是需要回调的,当接收到订单的回调时候,需要判断该订 单的报告是否生成成功, 如果报告生成则可以调用查看报告详情页的接口和查看报告 json 的接口然后解析. 如果报告生成失败,会有相应的失败的原因. 3.如果购买报告的时候没有传入回调的地址,说明不需要回调,则需要接口的用户调用查看订单状态的接 口查看订单的状态,如果订单的状态为已出报告的时候则可以调用查看报告详情页的接口和查看报告 json 的接口然后解析.如果报告生成失败,会有相应的失败的原因. 4.由于文档中有些 code 码没有统一,敬请谅解,后期我们会统一. 第5页1购买报告接口 Api 环境: 环境 Api 地址 请求方式 正式 http://api.chaboshi.cn/report/buy_report?(支持 https) POST 接口调用: CBS.getInstance( userid,keysecret ).getBuyReport(vin, engino,licenseplate, callbackurl);

1.1 参数说明: 调用接口传入的参数: 参数名称 参数类型 可空 说明 vin Stirng 否Vin 码callbackurl String 是 (请求的格式必须是 http://或者 https://), 回调地址中不能加参数. 如果不 填的话就设置为 null. enginno String 是 发动机号(有些品牌的查询需要发动机号) licenseplate String 是 车牌号(有些品牌的查询需要车牌号) 接口返回的参数: 参数名称 参数类型 可空 说明 Code String 否 结果代码 Message String 否 结果描述 orderId String 是 订单号,如果购买不成功则没有订单号,只 有当 Code 为

0 的时候才有 orderId. 第6页1.2 购买报告接口 Code 码表: Code Message

0 成功

1000 用户未授权

10001 用户未授权

1001 签名错误

1002 账户余额不足

1100 暂不支持这个品牌

1101 数据维护中

11011 数据维护中

11012 数据维护中

11013 数据维护中

1107 服务异常

11071 服务异常

1201 无效 vin 码12011 无效 vin 码1202 无效车牌号

12021 无效车牌号

1203 无效发动机号

12031 无效发动机号

1204 用户 id 错误

1205 回调地址错误(如果回调地址为空, 说明不需 要回调;

如果回调不符合 http://、 https://的格式的话就提示对调地址格式 不对)

99999 未知错误 2.查看订单状态接口 Api 环境: 环境 Api 地址 请求方式 正式 http://api.chaboshi.cn/report/get_report_status?(支持 https) GET 接口调用: CBS.getInstance( userid,keysecret ).getReportStatus(orderid);