API参考

API参考文档

快速集成OCR识别服务

概述

我们提供RESTful API接口,支持多种编程语言,5分钟即可完成集成。所有API请求使用HTTPS协议,确保数据传输安全。

Base URLhttps://api.ocrproducts.cn/v1
认证方式API Key
请求格式JSON / Multipart
响应格式JSON

认证

所有API请求需要在Header中包含API密钥:

Authorization: Bearer YOUR_API_KEY

您可以在控制台获取API密钥。

核心接口

身份证识别

POST/ocr/idcard

识别身份证正反面信息

请求参数

参数 类型 必填 说明
image file/base64 身份证图片
side string front(正面) / back(反面)

响应示例

{n  "code": 0,n  "message": "success",n  "data": {n    "name": "张三",n    "id_number": "110101199001011234",n    "address": "北京市朝阳区...",n    "birth": "1990-01-01",n    "gender": "男",n    "nation": "汉"n  }n}

发票识别

POST/ocr/invoice

识别增值税发票信息

请求参数

参数 类型 必填 说明
image file/base64 发票图片
type string 发票类型

银行卡识别

POST/ocr/bankcard

识别银行卡号和银行信息

户口本识别

POST/ocr/household

识别户口本页面信息

错误代码

代码 说明 解决方案
0 成功
1001 API密钥无效 检查API密钥是否正确
1002 余额不足 请充值
2001 图片格式错误 支持JPG/PNG/PDF
2002 图片过大 图片大小不超过10MB
3001 识别失败 请检查图片质量
5000 服务器错误 请联系技术支持

SDK下载

Python SDK

pip install ocr-sdk

查看文档 →

Java SDK

maven dependency

查看文档 →

PHP SDK

composer require ocr/sdk

查看文档 →

Node.js SDK

npm install ocr-sdk

查看文档 →

快速开始

Python示例

import ocr_sdknnclient = ocr_sdk.Client("YOUR_API_KEY")nresult = client.idcard("idcard.jpg", side="front")nprint(result)
💬 联系我们

联系我们