开放 API 接口开发指南

所有接口请求必须在 URL 中带上以下鉴权参数：

请求 URL: /Code.ashx?op=code&app=api&token=YOUR_TOKEN&type=0

调用方式: POST

参数统一拼在 URL 中，图像数据通过 POST body 传递（支持 multipart 文件流、表单字段或纯文本）。

2.1 输入待识别图像 (三选一)

2.2 核心模式与引擎控制

2.3 格式化与排版规则 (可选)

以下参数传值 1 开启对应处理，值 0 不开启。
若无特定需求，建议不传，留给系统决断：

2.4 返回值说明 (JSON)

识别接口返回标准 JSON 格式。值为 null 的字段会自动省略。

顶层字段

result 子对象 — 文本结果

result 子对象 — 坐标定位数据 🗺️

以下字段包含每个文本块在原图上的精确位置，适用于需要做高亮叠加、区域提取等场景。

verticalText 中的 TextCellInfo 对象结构

[
  {
    "words": "识别出的文字内容",
    "trans": "翻译结果（如有）",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result 子对象 — 文件下载

files 中的 DownLoadInfo 对象结构

state 状态枚举

返回示例

✅ 成功响应（含坐标数据）：

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "智能合并后的完整文本",
    "spiltText": "按段落分割的原始文本",
    "verticalText": "[{\"words\":\"你好\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ 错误/限额响应：

{
  "ocrType": 0,
  "processName": "温馨提示",
  "result": {
    "spiltText": "今日API额度已用尽，请充值后继续使用！",
    "autoText": "今日API额度已用尽，请充值后继续使用！"
  },
  "id": 1
}

请求 URL: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

调用方式: POST

功能: 根据识别接口返回的 id 查询异步处理结果。当识别接口返回 state=0（待处理）时，可使用此接口轮询获取最终结果。

返回示例

✅ 成功响应：

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "识别结果文本",
      "spiltText": "分段文本",
      "resultType": 0
    }
  }
]

❌ 失败响应（ID 不存在或结果已过期）：

no

返回纯文本 no 表示未找到该 ID 对应的结果，可能是 ID 错误或结果已过期被清除。

请求 URL: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

调用方式: POST (multipart/form-data)

功能: 上传一张图片到免费图床，返回可公网访问的直链 URL。适用于需要先上传图片、再用 URL 调用识别接口的场景。

返回示例

✅ 成功响应：

https://cdn.example.com/uploads/abc123.jpg

❌ 失败响应（未上传文件或上传异常）：

no

返回纯文本 no 表示未接收到文件或上传过程中发生异常。

请求 URL: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

调用方式: GET

通过该接口可查看 Token 今日已用的次数、以及剩余次数配额。

返回示例

✅ 成功响应：

{
  "Account": "api",
  "TodayCount": 52,        // 今日已用次数
  "LimitCount": 9948       // 当前总剩余次数
}

❌ 失败响应（Token 无效或未传）：

{
  "Account": "api",
  "TodayCount": 0,
  "LimitCount": 0
}

注意：Token 无效时不会报错，而是返回数值全为 0 的 JSON，请根据 LimitCount 是否为 0 来判断 Token 有效性。