一、开通文字识别服务
在调用文字识别相关接口前,你需要进入 文字识别控制台,阅读《文字识别服务条款》后勾选同意并单击立即开通,即可一键开通通⽤⽂字、卡证⽂字、票据单据等服务接⼝。
服务开通成功后,你将获得各项服务对应的免费调用额度,可在 资源包管理页 查看。同时你也可以在 文字识别购买页 中购买对应文字识别服务的资源包,若免费额度以及资源包调用次数耗尽,接口计费将自动转为后付费方式按月进行结算,具体计费标准可以查看文字识别的 计费概述。
注意:文字识别服务开通成功后,你可根据喜好选择如下两种方式来调用文字识别服务,建议选择 API 3.0 Explorer。
二、输入参数
进入文字识别 API 3.0 Explorer 在线接口调试页面,选择需要调用的接口,并填写输入参数。
在 API 3.0 Explorer 界面的文档说明选项卡中可以查看对应接口输入参数的具体含义。
其中,Region表示提供文字识别服务的资源所在区,单击 Region 的下拉框可以选择不同地域的腾讯云服务器,建议选择与访问点 IP 地址距离相近的地域:例如你的访问点在深圳,建议 Region 选择距离较近的华南地区(广州)。
填写好输入参数之后,选择代码生成选项卡,可以看到自动生成的不同编程语言代码(可支持 Java、Python、Node.js、PHP、GO、.NET、C++ 语言),生成代码中的部分字段信息和填写内容是关联的,如需调整传入参数,可在左侧修改参数值后重新生成代码。
三、发起请求
填写好输入参数之后,选择在线调用选项卡,单击发送请求按钮可进行真实请求,供你调试、参考。
四、Postman 下载安装
1. 下载地址:Download Postman | Get Started for Free ,按照电脑类型选择安装包。
2. 下载完成后,双击打开安装包,按照提示安装,如无特殊需求选择默认即可。初次打开需要登录,若无账号,选择跳过。
五、接口调用
导入 Postman 配置
借助 Postman 的导入功能来初始化配置,配置链接:
https://ocr-documents-1258344699.cos.ap-guangzhou.myqcloud.com/postman_config.json
具体导入步骤如下:
初始配置包含两个接口示例,其所需配置信息都已包含在内。看到如下内容表示导入成功。
六、修改腾讯云密钥
发起请求前,需先将该请求对应 Pre-request-Script 中的密钥修改为自己的,这样脚本才能正确计算鉴权参数。
1. 登录访问管理控制台 获取密钥。
2. 例如我们要调用 通用印刷体识别接口,修改其预处理脚本中的密钥。
七、发起请求
密钥修改完后,单击 Send 发送请求,看到如下内容表示请求成功。
八、参数介绍
OCR 服务(云 API)参数分为公共参数和非公共参数,以 通用印刷体识别接口 为例:
对应到 Postman 当中:
注意:公共参数传递时参数名需加上前缀 “X-TC-”,详情见 API 中心。
九、请求参数变更
如果想解析不同的图片或者设置不同的请求参数,步骤如下:
1. 查看接口入参定义,例如 身份识别接口。
2. 在 Body 中变更参数,例如我们想传递图片的 Base64 编码而不是 URL(图片跟 Base64 的转换自行搜索),则需传递 ImageBase64 参数,如身份证识别示例接口的传参。
十、请求接口变更
如需请求 OCR 服务的其他接口,需修改 Header 中的 X-TC-Action。
X-TC-Action 参数对应接口文档的 Action 入参,如身份证识别接口的 Action 为 IDCardOCR。
修改 Action 之后,再按照接口文档修改请求 Body,发起请求即可。