MAXScanner API v1
构建文档工作流,而不是处理基础设施。
面向文档、文件、OCR、转换、PDF、压缩和 Webhook 的异步优先 API。统一的认证模型、统一的作业生命周期和统一的结果契约。
认证
限定范围的 API 密钥
处理
异步作业
事件
签名 Webhook
参考
全部 API 操作
POST
/api/v1/jobs创建处理作业
提交异步处理操作,并获得稳定的作业标识符。
GET
/api/v1/jobs/{jobId}获取作业状态
读取处理作业当前的生命周期状态和结果信息。
GET
/api/v1/documents列出文档
列出已认证账户可用的文档。
POST
/api/v1/documents/{documentId}/process处理文档
为账户中的某个文档版本创建异步处理作业。
POST
/api/v1/files/upload授权文件上传
为私有源文件创建有限额的上传流程。
POST
/api/v1/convert转换文件
将受支持的文档转换路由到受管理的处理器集群。
POST
/api/v1/ocr运行 OCR
从受支持的图片或文档中提取可搜索的文本。
POST
/api/v1/pdf运行 PDF 操作
提交受支持的 PDF 操作,例如合并、拆分或优化。
POST
/api/v1/compress压缩图片
提交带有格式和质量约束的图片优化作业。
POST
/api/v1/webhooks创建 Webhook
为作业和文档事件注册带签名的回调目标。
GET
Error reference错误参考
了解认证、校验、配额、冲突和服务器错误。
GET
Limits & formats限额与格式
查看受支持的格式、配额和请求约束。