# 店招比对接口

接口说明:判断主照片与副照片集中,是否为相同店招,与店招识别接口搭配使用。

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/ocr/v1/doorHeadCompare/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例:


{
  "compareBizId":"5442342354325",
  "hostImageBizId":"9542342384378",
  "hostImageUrl":"http://image.third.com/5164504684863877680/user_defined/201906/20190625133915796_4bba710b_CAMERA_11001999244.jpg",
  "slaveImages":[{
    "bizId":"3672342389625"
  }]
} 
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
compareBizId Long 业务调用id,不允许重复。由调用方给出,不能超过32位,提交图片后可根据该id查询识别结果
hostImageBizId Long 主照片店招识别业务id
hostImageUrl VARCHAR(200) 主照片url
slaveImages 比对集,最多支持50张照片
slaveImages.bizId VARCHAR(200) 每张比对照片均需先调识别接口,该参数为照片的店招识别业务id

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
  "compareBizId": 5442342354325,
  "compareListNum": 1,
  "compareListRecognizedNum": 1,
  "sameNum": 0,
  "compareResult": [
    {
      "hostImage": {
        "bizId": "9542342384378",
        "imageUrl": "http://image.third.com/5164504684863877680/user_defined/201906/20190625133915796_4bba710b_CAMERA_11001999244.jpg"
      },
      "slaveImage": {
        "bizId": "3672342389625",
        "imageUrl": "http://image.third.com/5164504684863877680/user_defined/201906/20190625133915796_4bba710b_CAMERA_33566787777.jpg"
      },
      "match": false
    }
  ]
}

参数说明:

参数 类型 说明
compareBizId Long 业务调用id,不允许重复。由调用方给出,不能超过32位,提交图片后可根据该id查询识别结果
compareListNum VARCHAR(200) 入参比对集照片数量,如50张
compareListRecognizedNum 比对集已识别的店招数,如50张中有30张识别过
sameNum 比对集中,与主照片为相同店招的数量,如50张中有30张识别过-10张照片为相同店招
compareResult 比对结果
compareResult.hostImage 主照片信息
compareResult.hostImage.bizId Long 主照片的店招识别业务id
compareResult.hostImage.imageUrl VARCHAR(200) 主照片url
compareResult.slaveImage 副照片信息
compareResult.slaveImage.bizId Long 副照片的店招识别业务id
compareResult.slaveImage.imageUrl VARCHAR(200) 副照片url
compareResult.match Boolean 是否为同一店招,主照片与比对照片是否为同一个店招,true/false

# 错误码

返回码return_code定义

编码 描述 排查方法
1020101007 请求超时 单次请求最多等待30s
1020101006 识别异常 店招识别接口异常,请联系管理员
1020101009 图片识别错误 图片未识别出来导致调用失败,不计费
1020101005 余额不足 店招识别产品余额不足,请联系管理员充值
1020101008 QPS超限额 QPS超限额,免费额度并发限制为2QPS
1020101003 图片为空
1020101004 图片损坏
1020101002 图片格式错误 支持PNG、JPG、JPEG、BMP
1020101000 请求参数缺失 请求缺失必要参数
1020101001 非法参数 请求中包含非法参数
1020101010 未知错误 未知错误,请再次请求, 如果持续出现此类错误,请在联系客户经理
1020101011 主照片识别失败