AutoX3 API
  • 快速开始
  • 文档说明
    • 阅读说明
    • 更新日志
    • 名词解释
  • 对接说明
    • 接口规范
    • 回调规则
    • 公共参数
  • 最佳实践
    • 对接流程
    • 方案介绍
    • APP对接
  • 标准接口
    • 获取平台访问凭证
    • 获取车辆检测报告
    • 创建接车订单回调
    • 检测报告发布回调
      • 轻度接入:h5检测报告内嵌url
      • 深度接入:完整检测结果数据
    • 车况&保养计划回调
    • 保养计划回调V2
  • 定制接口
    • 同步车辆服务项目信息
    • 同步施工工艺模板信息
    • 同步施工报告结果信息
      • 轻度接入:h5施工报告内嵌url
      • 深度接入:完整施工结果数据
  • APP接口
    • 获取检测项目列表
    • 创建开放平台检测单
    • 获取检测模块列表
    • 获取检测项列表
    • 更新检测模块
    • 发布检测报告
    • 文件上传
    • 字典-获取检测模块字典
  • 常见问题
    • 加密代码DEMO
    • HTTPS设置说明
  • 多语言
    • English
Powered by GitBook
On this page
  • 请求地址
  • 请求参数
  • 鉴权成功应答参数
  • 鉴权失败应答参数

Was this helpful?

  1. 标准接口

获取车辆检测报告

请求地址

环境

HTTPS请求地址

国内沙盒环境

https://cnopenapi.autox3.com/openapi/api-v1/rest

国内生产环境

https://cnopengateway.autox3.com/openapi/api-v1/rest

其他国家环境

略

请求参数

名称

子项目

是否必填

长度

类型

说明

method

是

64

String

autox3.order.detection.report.list

content

是

200

String

请求接口内容字符串JSON

carNum

是

64

String

车牌号

isNeedJson

否

--

Boolean

是否返回检测报告JSON

请求命令(以curl命令为例)示例如下:

curl 'https://cnopenapi.autox3.com/openapi/api-v1/rest' \
-H "accept: */*"  \
-H "Authorization: ${token}" \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"method": "autox3.order.detection.report.list",
"content":"{\"carNum\":\"云M16987\",\"isNeedJson\":\"false\"}"}' \
--compressed               

鉴权成功应答参数

名称

子项

是否必填

长度

类型

说明

示例值

status

是

--

Integer

请参考本页"公共参数-->错误编码"部分

0

errorInfo

是

--

String

错误信息

network error

data

是

--

Object

接口返回值json串,具体见业务响应参数

carNum

是

--

Integer

过期时间,单位:秒,目前开放平台默认过期时间为7天

529200

h5Url

是

--

String

h5报告url

https://h5.abc.com/report

releaseDate

是

--

String

报告发布时间

2021-03-31 13:34:30

reportScore

是

--

Float

报告评分

100.0

reportJson

否

--

String

当isNeedJson = true时,返回检测报告JSON内容

"{}"

示例如下:

无 reportJson 结构

{
	"data":[
		{
			"carNum":"京M12654",                    
			"h5Url":"${url}",                      
			"releaseDate":"2021-03-31 13:34:30",   
			"reportScore":100.0,
			"reportJson":null                    
		}
	],
	"errorInfo":null,
	"status":0
}  

有 reportJson 结构

{
	"data":[
		{
			"carNum":"京M12654",                    
			"h5Url":"${url}",                      
			"releaseDate":"2021-03-31 13:34:30",   
			"reportScore":100.0,
			"reportJson": "{                         //  检测报告JSON字符串
          "workBaseStatus": false,           
          "carNum": "京M65068",               // 车牌号 
          "serviceBaseName": "全车油液检查",    // 检测项目名称 
          "list": [                           // 检测答案List 
            {
              "evaluation": "这是一条评论",     // 技师评论
              "itemAmount": 1,                // 检测项数量 
              "questionToSystemId": 1619,     // 问题系统ID
              "templetItemEntityList": [      // 检测项对象数组
                { 
                  "carId": 1846,              // 车辆id 
                  "mimeTupleList": [          // 检测结果照片/视频 list 
                    {
                      "key": 338578,          // 资源id 
                      "mimeType": "image/*",  // 资源类型 image/*  video/*
                      "value": "${url}"       // 资源URL
                    }
                  ],
                  "questionDetectionTempletQuestionList": [    // 检测点列表
                    {
                      "answer": "20%",                // 检测点答案
                      "currentMiles": 49709,          // 车辆创建检测报告时的里程
                      "description": "刹车油剩余",      // 检测点名称 
                      "id": 10862,                    // 模版检测点ID
                      "normalOrNot": 2,               // 正常选项 (0异常 1正常 2紧急 3轻微异常 ) 
                      "normalValue": "D",             // 正常选项值
                      "perMiles": 12.0980971,         //  车辆创建检测报告时的日均里程
                      "questionBaseId": 7337,         // 检测点id
                      "questionBaseStatus": "DANGEROUS",    // 检测点状态(PASS,正常;MINOR,轻微异常;MAJOR,异常;DANGEROUS,紧急;)
                      "questionBaseStatusDesc": "紧急",      // 检测点状态 描述 
                      "soundOrNot": false,                  // 
                      "takePhotoOrNot": true,
                      "touchCycleBaseServiceEntityList": [  // 检测点推荐项目
                        {
                          "currentMiles": 49709,               // 车辆创建检测报告时的当前里程
                          "detectionPointName": "刹车油剩余",    // 检测点名称
                          "perMiles": 12.0980971,              // 车辆创建检测报告时的日均里程
                          "restSafeMilesKm": 0,                // 车辆创建检测报告时的安全里程
                          "serviceBaseName": "12345copy1",     // 推荐服务项目名称
                          "serviceBaseSn": "0009copy10704051301",  // 推荐服务项目名称SN
                          "touchQuestionBaseId": 7337          // 触发的检测点ID
                        }
                      ],
                      "type": "CHOICE"       // 检测选项类型(CHOICE,单选题;TYRE_CHOICE,轮胎单选组合题;NUMBER,数值;)
                    }
                  ],
                  "questionToItemId": 4671,  // 检测项ID
                  "resourceIdList": [        // 检测结果图片id List 
                    338578,
                    338579
                  ],
                  "resourceUrlList": [       // 检测结果图片url List
                    "${url}"
                  ],
                  "toItemDesc": "刹车油"      // 检测项描述
                }
              ],
              "toSystemDesc": "刹车油"        // 所属系统的描述
            }
          ],
          "perMiles": 19.47,                   // 预估动态日均里程
          "currentMiles": 80000,               // 预估动态当前里程
          "maintenancePlanAndQuestion": {      // 保养计划 & 车况问题列表
            "carMaintenancePlanList": [        // 保养计划列表
              {
                "currentMiles": 1242,          // 当前里程
                "expiredDays": 25,             // 过期天数(大于零:已过期x天;小于零:还有x天过期)
                "expiredMiles": 388,           // 过期里程(大于零:已超过x里程/小于零:还有x里程过期)
                "finish": true,                      // 是否已编辑完成
                "forecastPrice": 10000.0,            // 预测服务项目价格
                "id": 1700,                          // 保养计划id
                "mgtModified": 1622013059000,        // 最近修改时间
                "nextReplaceCycleKm": 854,           // 下次保养里程
                "operator": "yang xingxingxing2",    // 操作人
                "payProbability": 0.0,               // 成交概率
                "perMiles": 15.5342798,              // 平均里程
                "recommend": true,                   // 是否推荐立即保养
                "reductionType": "TIME",             // 维保计划计算类型
                "serviceBaseName": "wash car",       // 服务项目SN
                "serviceBaseSn": "00107040513",      // 服务项目SN Name  
                "warningDate": "2021-05"             // 计划报警日期 
              }
            ],
            "carNum": "KAKA100",                     // 车牌号
            "workProcedureQuestionList": [           // 车况问题列表 
              {
                "optionDescription": "51",           // 检测点问题答案
                "questionBaseDescription": "error-indirect",  // 检测点描述
                "questionBaseId": 5911,              // 检测点ID
                "workProcedureQuestionId": 9133      // 检测记录ID
              }
            ]
          }
          "staffInfo": {                       // 员工信息
            "areaCode": "+44",                 // 所属国家区号
            "brandId": 5,                      // 品牌id
            "mobile": "13133330000",           // 手机号
            "staffId": 1,                      // 员工id
            "staffName": "A梦 哆啦",            // 员工名称
            "storeId": 1                       // 店铺id
          }
        }"                    
		}
	],
	"errorInfo":null,
	"status":0
}  

鉴权失败应答参数

名称

是否必填

长度

类型

说明

示例值

status

是

--

Integer

请参考本页"公共参数-->错误编码"部分

403

error

是

--

String

错误信息

Forbidden

path

是

--

String

请求路径

/openapi/api-v1/rest

message

是

--

String

消息提示

Access Denied

timestamp

是

--

String

时间

2021-06-02 11:50:34

示例如下:

{
  "timestamp": "2021-06-02 11:50:34",
  "status": 403,
  "error": "Forbidden",
  "message": "Access Denied",
  "path": "/openapi/api-v1/rest"
} 

Previous获取平台访问凭证Next创建接车订单回调

Last updated 3 years ago

Was this helpful?