API开放平台

TIP

# 店招识别接口

接口说明：识别店招照片中的信息，如店名、分店名、品牌、电话、其他字段等。

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


{

 "bizId": 9322096116708482104, 
 "imageUrl": "http://image.third.com/5164504684863877680/user_defined/201906/20190625133915796_4bba710b_CAMERA_11001999244.jpg"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
bizId Long 是 业务调用id，不允许重复。由调用方给出，不能超过32位，提交图片后可根据该id查询识别结果
imageUrl VARCHAR(200) 是 图片完整url，url长度不超过1024字节，url对应的图片base64编码后大小不超过4M，最短边至少15px，最长边最大4096px，支持jpg/jpeg/png/bmp格式。

响应示例：

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

数据DATA示例:

{
  "bizId": 9322096116708482104,
  "imgUrl": "http://image.third.com/5164504684863877680/user_defined/201906/20190625133915796_4bba710b_CAMERA_11001999244.jpg",
  "nameBox": [
    {
      "content": "香烟名酒",
      "score": 0.5,
      "x1": 186,
      "x2": 529,
      "y1": 188,
      "y2": 381
    }
  ],
  "subNameBox": [
    {
      "content": "鑫慕食品店",
      "score": 0.5,
      "x1": 198,
      "x2": 380,
      "y1": 178,
      "y2": 288
    }
  ],
  "brandNameBox": [
    {
      "content": "XXX品牌",
      "score": 0.5,
      "x1": 186,
      "x2": 529,
      "y1": 188,
      "y2": 381
    }
  ],
  "telBox": [
    {
      "content": "190826111342",
      "score": 0.5,
      "x1": 198,
      "x2": 380,
      "y1": 178,
      "y2": 288
    }
  ],
  "otherBox": [
    {
      "content": "烟酒超市",
      "score": 0.5,
      "x1": 626,
      "x2": 688,
      "y1": 635,
      "y2": 802
    }
  ]
}

参数说明：

参数 类型 说明
bizId Long 业务调用id，不允许重复。由调用方给出，不能超过32位，提交图片后可根据该id查询识别结果
imageUrl VARCHAR(200) 图片URL地址
nameBox 店名
nameBox.content VARCHAR(200) 内容
nameBox.score NUMERIC 得分
nameBox.x1 NUMERIC 识别文字x1点坐标
nameBox.y1 NUMERIC 识别文字y1点坐标
nameBox.x2 NUMERIC 识别文字x2点坐标
nameBox.y2 NUMERIC 识别文字y1点坐标
subNameBox NUMERIC 分店名
subNameBox.content VARCHAR(200) 内容
subNameBox.score NUMERIC 得分
subNameBox.x1 NUMERIC 识别文字x1点坐标
subNameBox.y1 NUMERIC 识别文字y1点坐标
subNameBox.x2 NUMERIC 识别文字x2点坐标
subNameBox.y2 NUMERIC 识别文字y1点坐标
brandNameBox 品牌
brandNameBox.content VARCHAR(200) 内容
brandNameBox.score NUMERIC 得分
brandNameBox.x1 NUMERIC 识别文字x1点坐标
brandNameBox.y1 NUMERIC 识别文字y1点坐标
brandNameBox.x2 NUMERIC 识别文字x2点坐标
brandNameBox.y2 NUMERIC 识别文字y1点坐标
telBox 电话号码栏
telBox.content VARCHAR(200) 内容
telBox.score NUMERIC 得分
telBox.x1 NUMERIC 识别文字x1点坐标
telBox.y1 NUMERIC 识别文字y1点坐标
telBox.x2 NUMERIC 识别文字x2点坐标
telBox.y2 NUMERIC 识别文字y1点坐标
otherBox 其他信息
otherBox.content VARCHAR(200) 内容
otherBox.score NUMERIC 得分
otherBox.x1 NUMERIC 识别文字x1点坐标
otherBox.y1 NUMERIC 识别文字y1点坐标
otherBox.x2 NUMERIC 识别文字x2点坐标
otherBox.y2 NUMERIC 识别文字y1点坐标

# 错误码

返回码return_code定义

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

← 店招比对接口 →