开发者 API 与自动化

基于 MAXScanner 构建文档自动化

用于文档转换、合并和 OCR 的 REST API，并全面支持 Zapier、Make 和 n8n。免费开始，无需信用卡。

快速开始

登录并打开你的控制台，然后进入 API 与自动化 → API 密钥 → 新建密钥。
复制密钥（只显示一次），格式类似 mxs_xxxxxxxx_xxxxxxxxxxxx。
在每个请求中以 Bearer 令牌发送：Authorization: Bearer YOUR_API_KEY。

curl -X POST https://maxscanner.app/api/v1/convert \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/report.docx","filename":"report.docx","format":"pdf"}' \
  --output report.pdf

实时

立即试用 API

这会调用真实的 /api/v1/sandbox/convert 端点，转换一份即时生成的小型演示文档。无需 API 密钥，且只能在 maxscanner.app 的此页面上使用，因此无法被嵌入或在其他地方抓取。

调用限额与免费额度

免费套餐

每天 10 次

每月 100 次请求，永久免费，无需信用卡。

付费套餐

2,000 次 – 无限制

Starter（每月 2,000 积分）、Pro（每月 10,000）、Business（无限制）。

付费套餐按操作消耗积分：

转换 — 2 积分合并 — 1 积分OCR — 3 积分用量查询 — 免费

端点

基础 URL： https://maxscanner.app/api/v1

GET/health免费，无需密钥

检查 API 是否在线，适用于 Zapier 的“测试连接”步骤。

响应

{ "status": "ok", "service": "MAXScanner Public API", "version": "v1" }

GET/usage免费

查看所发送密钥的当前套餐和剩余配额。

响应

{ "plan": "Free", "limits": { "per_day": 10, "per_month": 100 },
  "remaining": { "today": 7, "this_month": 84 } }

POST/convert2 积分

将 URL 上的文档转换为其他格式（pdf、docx、xlsx、pptx、txt、html、png 等）。

请求体

{ "url": "https://example.com/report.docx",
  "filename": "report.docx", "format": "pdf" }

响应

二进制文件（Content-Type 与请求的格式一致）

POST/merge1 积分

按给定顺序将 2–20 个 PDF（以 URL 提供）合并为一个 PDF。

请求体

{ "files": ["https://.../page1.pdf", "https://.../page2.pdf"] }

响应

二进制文件 (application/pdf)

POST/ocr3 积分

通过真正的 OCR 从扫描图片或 PDF 中提取文字，即使完全没有文字层也能使用。

请求体

{ "url": "https://.../scan.pdf", "filename": "scan.pdf", "language": "eng" }

响应

{ "text": "...", "pages": 3, "language": "eng" }

POST/documents/import1 积分

从自动化流程中把文件导入你的 MAXScanner 文档库，与 /convert 方向相反。

请求体

{ "url": "https://.../invoice.pdf", "filename": "invoice.pdf" }

响应

{ "id": "...", "filename": "invoice.pdf", "downloadUrl": "..." }

POST/hooks/subscribe免费

注册一个 Webhook URL，以接收某一类型的后续事件。请参阅下方的“Webhook、Zapier 和 n8n”。

请求体

{ "event": "scan.created", "targetUrl": "https://hooks.zapier.com/..." }

响应

{ "id": "...", "event": "scan.created", "targetUrl": "..." }

POST/hooks/unsubscribe免费

按 id 删除 Webhook 订阅。

请求体

{ "id": "..." }

响应

{ "success": true }

GET/hooks免费

列出当前有效的 Webhook 订阅，以及每个订阅最近一次投递的状态。

响应

{ "subscriptions": [{ "id": "...", "event": "scan.created", "targetUrl": "..." }] }

/convert 支持（不只是 Office 格式）

Word / Excel / PowerPointPDF经典的“Office 转 PDF”

PDFWord / 纯文本 / HTML“PDF 转 Office”

PDFPNG / JPG 图片每页一张图片

PNG / JPG 图片PDF将图片转为 PDF 页面

Zapier、Make、n8n 与 Webhook

将 MAXScanner Android 应用与 5,000 多个应用连接。在应用中打开 设置 → Zapier 与自动化（或“工具”中的 API 与自动化 卡片）订阅并获取集成密钥，然后在 Zapier 的连接步骤中将其用作 MAXScanner API 密钥。同一密钥也可用于上方的 REST 直接调用。

可用触发器

新的扫描文档scan.created所有套餐

每当在应用中扫描新文档时触发。

新的 PDF 导出pdf.exported所有套餐

当文档组导出为 PDF 时触发。

新的带位置扫描geotag.capturedPro 及以上

针对带有位置信息（地址、城市、坐标）的扫描触发。

新的时间戳拍摄timestamp.capturedBusiness

针对带时间戳的拍摄触发。

新的 OCR 文本ocr.completedPro 及以上

当扫描的设备端 OCR 文本可用时触发。

新的二维码扫描qr.scanned所有套餐

在应用中扫描二维码时立即触发，并附带解码后的文本。

Make.com

可视化自动化场景

n8n

自托管工作流自动化

Webhook

用于其他一切的直接 HTTP 回调

这三个平台在这里的用法完全相同：它们提供一个 URL，你通过 /hooks/subscribe 让 MAXScanner 向该 URL 发送 POST。目前还没有可安装的 Zapier 原生应用，使用的是 Zapier 自带的通用操作 Webhooks by Zapier，现在即可使用。

⚡ Zapier 分步说明

创建 Zap → 搜索 Webhooks by Zapier 应用 → 选择触发事件 Catch Hook。
Zapier 会显示一个专属 Webhook URL（例如 https://hooks.zapier.com/hooks/catch/...），复制它。
使用该 URL 和所需事件调用一次 MAXScanner 的 /hooks/subscribe（参见下方 curl 示例）。
回到 Zapier，在应用中触发一个测试事件（例如扫描一份文档），Catch Hook 步骤应显示示例数据。然后继续构建 Zap 的操作步骤（Google 云端硬盘、表格、Slack、电子邮件等）。

🔄 n8n 分步说明

在新工作流中添加一个 Webhook 触发节点，并设置为接受 POST 请求。
复制该节点的 Production URL（请先启用工作流，使其处于运行状态）。
使用该 URL 和所选事件调用 /hooks/subscribe。
在应用中触发测试事件，Webhook 节点会接收负载，便于接入工作流的后续步骤。

通过 curl 订阅

curl -X POST https://maxscanner.app/api/v1/hooks/subscribe \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"scan.created","targetUrl":"https://hooks.zapier.com/hooks/catch/.../..."}'

准备好自动化你的文档了吗？

创建免费 API 密钥：每天 10 次、每月 100 次请求，无需银行卡。

我的工具箱