接口说明

请求Host

更多信息请查看开发前必看#访问域名。

请求说明

请求格式遵循Restful API风格。具体详细信息请查看每个API。

• 当您提交一个请求到Clobotics OpenAPI时，HTTP状态码200代表服务器已经成功接受到请求，业务逻辑或者其他异常请查看返回结果说明。
• 当由于网络问题或者其他原因导致请求超时时，请重新提交。
• 如果HTTP状态码4xx，请检查您的API或者请求格式是否正确。
• 如果HTTP状态码5xx，请联系我们进行处理。

返回结果说明

正常返回示例

{
    "code": 0, 
    "message": "", 
    "data": {}
}

注意：

• code=0代表请求数据成功.
• data为返回的业务数据，根据相应的业务进行处理。

错误返回示例

{
    "code": 1003, 
    "message": "task id: [5177er673782738882873211] not exist", 
    "data": null
}

注意：

• 如果code不等于0，则代表请求失败。
• 关于错误码的更多信息，请查看 错误码说明 。
• message在code不等于0时有值，返回相应的错误信息。

Task识图指标说明

获取识图结果返回结果中的metrics表示任务级别的KPI数据，可能包含总排面、总空位等指标。

注意：

• 下面提到的指标项并不是全部可用，根据不同的合同要求，可能会有不同的指标项，具体请联系您的客户经理（CSM）。

• 该说明仅用于处理 获取识图结果中的返回的metrics。

指标项定义：

Id	名称	描述
2	Total empty space	空位数
3	Total facing	总排面（含空位）
5	Total row	总行数
9	Total door	总门数

Task识图质量说明

获取识图结果返回结果中的qualities表示任务级别的图像质量问题，用来确认图片是否存在问题。

Task质量定义

Id	描述
2	曝光不足
3	曝光过度
4	模糊
10	翻拍
15	图片重用
28	摆拍
29	局部拍摄
30	任务超时
31	不相关图片
32	重用含分数，值的格式为json字符串：[{"task_id":"xxx", "score":0.8}]

访店计划质量说明

获取访店计划列表返回结果中的qualities表示访店计划的质量问题。 一般来说，一个访店计划可能包含多个任务，访店计划是任务的上层结构。因此，访店计划的qualities会根据计划中的所有任务来汇总质量问题。

注意：

• 尽管访店计划的质量和Task的识图质量字段都是quality，但是他们的定义是不相同的。

访店计划质量定义:

Id	描述
18	纯净度达到阈值。客户设置一个阈值，判断plan下所有的识图任务纯净度是否达到阈值
19	GPS偏移。访店时的坐标和门店存在位置偏移
21	一个访店计划下是否存在照片重新使用
22	访店计划过期。
23	访店计划中存在不相关的图片. 不相关图片意味着照片上没有有用的目标信息，例如风景画等
25	访店计划中存在翻拍的照片