请求HEADER
名称 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded;charset:utf-8; |
请求参数说明
名称 | 要求 | 类型 | 示例值 | 说明 |
---|---|---|---|---|
secret | 必填 | string | Ptjw1Du3l0t3JM10oD5I6fGOMV | 您的密钥,在密钥管理中查看 |
image_url | 选填 | string | http://img.alicdn.com/i1/O1CN01iRgEQw1GCt4zeHxtk_!!0-imgsearch.jpg | 待查询的图片链接 |
响应HEADER
名称 | 值 | 说明 |
---|---|---|
X-Rate-Limit-Limit | 5 | 当前接口请求频率限额 |
X-Rate-Limit-Remaining | 2 | 一段时间内剩余允许请求数,该值为0表明达到当前接口最大请求频率/次数限制,应适当降低请求频率 |
X-Rate-Limit-Global | 1 | 该值为1表明触犯全局请求频率/次数限制,应适当降低请求频率 |
返回参数说明
名称 | 类型 | 说明 |
---|---|---|
code | number | 返回码,具体含义请参考错误码参照 |
msg | string | 返回说明 |
data | json | 返回结果集 |
rid | string | 请求ID |
JSON结果集返回示例
[{"key":"ret_id","sample":"132292916730768750","type":"number","value":"请求ID"},{"key":"ret_body","sample":"{\"log_id\":8015678402131366998,\"words_result_num\":11,\"words_result\":{\"国家码\":{\"location\":{\"width\":59,\"top\":76,\"left\":408,\"height\":22},\"words\":\"CHN\"},\"护照签发地点\":{\"location\":{\"width\":171,\"top\":317,\"left\":293,\"height\":25},\"words\":\"广东/GUANGDONG\"},\"有效期至\":{\"location\":{\"width\":178,\"top\":315,\"left\":555,\"height\":24},\"words\":\"20290117\"},\"签发机关\":{\"location\":{\"width\":261,\"top\":368,\"left\":292,\"height\":24},\"words\":\"中华人民共和国国家移民管理局\"},\"护照号码\":{\"location\":{\"width\":174,\"top\":77,\"left\":583,\"height\":30},\"words\":\"EF1260892\"},\"姓名拼音\":{\"location\":{\"width\":222,\"top\":154,\"left\":298,\"height\":24},\"words\":\"ZHENGJIAN,YANGBEN\"},\"出生地点\":{\"location\":{\"width\":171,\"top\":264,\"left\":294,\"height\":25},\"words\":\"广东/GUANGDONG\"},\"姓名\":{\"location\":{\"width\":154,\"top\":127,\"left\":297,\"height\":28},\"words\":\"证件样本\"},\"签发日期\":{\"location\":{\"width\":178,\"top\":263,\"left\":555,\"height\":24},\"words\":\"20190118\"},\"生日\":{\"location\":{\"width\":139,\"top\":211,\"left\":553,\"height\":25},\"words\":\"19850320\"},\"性别\":{\"location\":{\"width\":50,\"top\":214,\"left\":294,\"height\":22},\"words\":\"女/F\"}}}","type":"string","value":"返回内容"},{"key":"ret_message","sample":"","type":"string","value":"错误信息"},{"key":"ret_code","sample":"0","type":"number","value":"错误代码"}]
系统级错误码参照
错误码 | 说明 |
---|---|
500 | 缺少参数密钥KEY |
501 | 密钥KEY错误或已失效 |
502 | 密钥KEY已禁用,平台黑名单 |
503 | IP地址不被平台允许 |
504 | 接口不存在或已下线 |
505 | 接口维护中,请稍后访问 |
506 | 接口不支持该方式请求 |
507 | 接口不支持GET方式请求 |
508 | 接口不支持POST方式请求 |
509 | 服务端执行错误 |
510 | 服务端数据解析错误 |
服务级错误码参照
错误码 | 说明 |
---|---|
400 | 密钥KEY错误或已失效 |
401 | 密钥KEY已禁用 |
402 | IP地址不被用户允许 |
403 | 账号余额不足,请及时充值 |
404 | 超过当前接口每日调用限制 |
405 | 超过当前接口每秒调用限制 |
406 | 请求参数错误 |
407 | 请求失败,后端错误 |
错误码格式说明
5xx | 4xx | xx |
---|---|---|
系统级错误 | 服务级错误 | 具体错误代码 |