ScanFile API提供文件扫描功能，将文档图片（例如试卷、书籍、公文、证件、线稿等）转换为扫描件。-阿里云帮助中心

扫描文件接口利用最新的AI技术，将文档图片（例如试卷、书籍、公文、证件、线稿等）转换为扫描件。接口具有强大的图像处理能力，能够有效去除噪声、矫正图片的形变，能够实现拍照替代传统扫描仪的高清扫描效果。

接口定义

请求参数

参数		类型	必填	默认值	描述	示例值
imageUrl		string	否	-	IQS服务端可访问的图片url	"www."
imageBase64		string	否	-	图片的base64内容	"/9j/4AAQSkZJR..."
scanFileInputConfig	autoCrop	string	否	true	是否裁剪，字符串类型： true(自动)/false(不)/force(强制);	false
scanFileInputConfig	autoRotate	string	否	true	是否旋转，字符串类型： true(自动)/false(不)/force(强制);	false

返回参数

字段		类型	是否可空	字段说明	样例（Query: 狮子）
requestId		string	不可空	请求RequestId, 排查问题时可以提供此信息	35E5608A-A737-2038-****-D9D34C6BFD9E
scanFileInfoList[]	angle	int32	不可空	图片的角度	0
	height	int32	不可空	图片的高度	3071
	width	int32	不可空	图片的宽度	1315
	imageBase64	string	不可空	图片base64	"/9j/4AAQSkZJR..."
searchInformation	searchTime	int64	不可空	搜索耗时	1048

说明

服务端的超时时间为25秒

示例

请求参数(RequestBody)

{
  "imageUrl": "https://img2.xxx"
}

返回参数

{
    "requestId": "c182ff0b-0a16-4a6d-a586-9841495bb3a2",
    "scanFileInfoList": [
        {
            "angle": 0,
            "height": 2178,
            "width": 1539,
            "imageBase64": "/9j/4AAQSkZJRgAgAooAKKACigD//Z"
        }
    ],
    "searchInformation": {
        "searchTime": 1265
    }
}

错误码

Status	错误码	错误信息	处理方案
404	InvalidAccessKeyId.NotFound	Specified access key is not found.	检查并确保AccessKey/Secret正确。
403	Retrieval.NotActivate	Please activate AI search service	请下单或联系您的客户经理进行开通。
403	Retrieval.Arrears	Please recharge first.	账户金额不足，请充值
403	Retrieval.NotAuthorised	Please authorize the AliyunIQSFullAccess privilege to the sub-account.	子账号没有进行授权，参考创建RAM用户并授权
403	Retrieval.TestUserPeriodExpired	The test period has expired.	测试已到期（自下单后15天有效），可以联系阿里云客户经理转正式
429	Retrieval.Throttling.User	Request was denied due to user flow control.	超出限流规格，可联系阿里云客户经理进行升配
429	Retrieval.TestUserQueryExceeded	The query exceed the limit	测试超出日限额（1000次/天），可以联系阿里云客户经理转正式

接口调用

HTTP调用

使用信息查询服务（IQS）产品的凭证（API-KEY）进行认证，并使用HTTP发起接口调用。创建、查看凭证Key，获取API-KEY。

curl  -X POST https://cloud-iqs.aliyuncs.com/scan/file \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{
  "imageUrl": "https://xxxxx"
}'

重要

$API_KEY 替换为信息查询服务控制台中创建的API-KEY（创建、查看凭证Key），创建API-KEY需要等待5min生效。

SDK调用

参考文档：SDK快速开始