# 通用 OCR API 接口


通用 OCR API 接口

通用图像识别接口。

![gugudata_api_cover](https://static.gugudata.com/api_ocr_v3.png)

# 1. 产品功能

- 通用的识别接口， 支持多种图片格式；
- 支持中英文字符混合识别；
- 支持 Base64 以及网络地址传参；
- 基于机器学习不断提高的识别率；
- 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
- 全面兼容 Apple ATS；
- 全国多节点 CDN 部署；
- 接口极速响应，多台服务器构建 API 接口负载均衡。

# 2. API 文档

**API 详情地址:** [https://www.gugudata.com/api/details/ocr](https://www.gugudata.com/api/details/ocr)

**接口请求地址:** [https://api.gugudata.com/imagerecognition/ocr](https://api.gugudata.com/imagerecognition/ocr)

**返回格式:** application/json; charset=utf-8

**请求方式:** POST

**请求协议:** HTTPS

**数据预览:** [https://www.gugudata.com/preview/ocr](https://www.gugudata.com/preview/ocr)

**请求示例:** [https://api.gugudata.com/imagerecognition/ocr](https://api.gugudata.com/imagerecognition/ocr)

**接口测试:** [https://api.gugudata.com/imagerecognition/ocr/demo](https://api.gugudata.com/imagerecognition/ocr/demo)

# 3. 请求参数

|   参数名    | 参数类型 | 是否必须 |   默认值    |                      备注                       |
| :---------: | :------: | :------: | :---------: | :---------------------------------------------: |
|   appkey    |  string  |    是    | YOUR_APPKEY |               付费后获取的 APPKEY               |
|  imageurl   |  string  |    否    | YOUR_VALUE  | 图片 URL 地址，与图标 Base64 编码选其一进行传参 |
| imagebase64 |  string  |    否    | YOUR_VALUE  | 图片 Base64 编码，与图标 URL 地址选其一进行传参 |

# 4. 返回参数

|              参数名              | 参数类型 |                      备注                      |
| :------------------------------: | :------: | :--------------------------------------------: |
|      DataStatus.StatusCode       |   int    |                 接口返回状态码                 |
|   DataStatus.StatusDescription   |  string  |                接口返回状态说明                |
|   DataStatus.ResponseDateTime    |  string  |                接口数据返回时间                |
|    DataStatus.DataTotalCount     |   int    |      此条件下的总数据量，一般用于分页计算      |
|       Data.SourceImageUrl        |  string  |    原始图片 URL，如果是 Base64 格式则不返回    |
|      Data.OcrResult[].Text       |  string  |                  识别出的文本                  |
| Data.OcrResult[].TextBoxPosition |  Array   | 识别出的文本位置，依次为四个顶点的 x 与 y 坐标 |