Api通用文档¶
请求URL和请求参数¶
- 接口地址: https://www.bingtop.com/ocr/upload/(兼容http)
https://www.bingtop.com/ocr/upload2/(包月识别专用) - 请求方式: post
- content-type: application/x-www-form-urlencode
- 返回格式: json数据格式
- 接口备注: 接口为长连接阻塞式,不需要轮询获取结果,建议设置超时时间40秒
- 参数说明:
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
username | 是 | string | 您注册登录的用户名 |
password | 是 | string | 您注册登录的密码 |
captchaType | 是 | int | 识别类型(整形),请点击查看 识别分类 页面 |
captchaData | 是 | string | 图片文件的base64编码 |
subCaptchaData | 否 | string | 第二图片的base64编码,非必须,少部分类型需要 如 1122类型、1306类型、1307类型等需求 |
- 响应参数说明:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 错误返回码,正常为0 |
message | string | 错误信息返回,正常为空 |
data[“captchaId”] | string | 识别ID(非数字格式,预留40字节字符串长度) |
data[“recognition”] | string | 识别结果 |
- 返回参数示例:
{
"code":0,
"message":"",
"data":{
"captchaId":"1000-158201918112812",
"recognition":"RESULT"
}
}
报错URL和报错参数¶
- 接口地址: http://www.bingtop.com/ocr/report/
- 返回格式: json
- 请求方式: post
- 接口备注: 如果识别结果为错误的,用识别时返回的captchaId进行报错,有效期2分钟
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
username | string | 您注册登录的用户名 |
password | string | 您的登录密码 |
captchaId | string | 识别错误的captchaId值 |
captchaType | int | 识别类型(整形) |
- 请求参数示例:
{
"username":"admin",
"password":"123456",
"captchaId":"1000-158201918112812",
"captchaType":1000
}
- 响应参数说明:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 错误返回码,正常为0 |
message | string | 错误信息返回,正常为空 |
data[“result”] | boolean | 报错成功状态值 |
- 响应参数示例:
{
"code":0,
"message":"",
"data":{
"result":true
}
}
查询剩余打码点数¶
- 接口地址: http://www.bingtop.com/ocr/check_points/
- 返回格式: json
- 请求方式: post
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
username | string | 您注册登录的用户名 |
password | string | 您的登录密码 |
- 请求参数示例:
{
"username":"admin",
"password":"123456"
}
- 响应参数说明:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 错误返回码,正常为0 |
message | string | 错误信息返回,正常为空 |
data[“points”] | int | 剩余点数 |
- 响应参数示例:
{
"code":0,
"message":"",
"data":{
"points":10000
}
}