SDK 与开发者工具
代码示例:Node.js、Python、PHP 和 cURL
完整、可直接复制的示例,用四种语言提交任务、带退避地等待任务完成并下载结果。
简要回答
在每种语言中都是同样的三个调用:携带 Idempotency-Key 调用 POST /api/v1/jobs/,带退避地轮询 GET /api/v1/jobs/{jobId}/,然后下载 output.downloadUrl。下面的示例都是包含超时和错误处理的完整程序;运行前请先在环境中设置 MAXSCANNER_API_KEY。
Node.js(18+)
使用内置的 fetch,因此无需安装任何包。
const KEY = process.env.MAXSCANNER_API_KEY;
const BASE = 'https://maxscanner.app/api/v1';
const headers = { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' };
const create = await fetch(`${BASE}/jobs/`, {
method: 'POST',
headers: { ...headers, 'Idempotency-Key': 'report-2026-11-pdf' },
body: JSON.stringify({ url: 'https://example.com/report.docx', filename: 'report.docx', format: 'pdf' }),
});
if (!create.ok) throw new Error(`create failed: ${create.status} ${await create.text()}`);
const { jobId } = await create.json();
let delay = 2000, job;
for (let i = 0; i < 60; i++) {
job = await (await fetch(`${BASE}/jobs/${jobId}/`, { headers })).json();
if (job.status === 'completed' || job.status === 'failed') break;
await new Promise((r) => setTimeout(r, delay));
delay = Math.min(delay * 1.5, 10000);
}
if (job.status !== 'completed') throw new Error(job.error || 'job did not finish');
const file = await fetch(job.output.downloadUrl);
await (await import('node:fs/promises')).writeFile('report.pdf', Buffer.from(await file.arrayBuffer()));Python
import os, time, requests
KEY = os.environ["MAXSCANNER_API_KEY"]
BASE = "https://maxscanner.app/api/v1"
S = requests.Session()
S.headers.update({"Authorization": f"Bearer {KEY}"})
r = S.post(f"{BASE}/jobs/", json={"url": "https://example.com/report.docx", "filename": "report.docx", "format": "pdf"},
headers={"Idempotency-Key": "report-2026-11-pdf"}, timeout=30)
r.raise_for_status()
job_id = r.json()["jobId"]
delay, job = 2.0, {}
for _ in range(60):
job = S.get(f"{BASE}/jobs/{job_id}/", timeout=30).json()
if job["status"] in ("completed", "failed"):
break
time.sleep(delay)
delay = min(delay * 1.5, 10)
if job.get("status") != "completed":
raise RuntimeError(job.get("error") or "job did not finish")
with open("report.pdf", "wb") as fh:
fh.write(requests.get(job["output"]["downloadUrl"], timeout=60).content)PHP
<?php
$key = getenv('MAXSCANNER_API_KEY');
$base = 'https://maxscanner.app/api/v1';
function api(string $method, string $url, string $key, ?array $body = null, array $extra = []): array {
$ch = curl_init($url);
$headers = array_merge(["Authorization: Bearer $key", 'Content-Type: application/json'], $extra);
curl_setopt_array($ch, [CURLOPT_CUSTOMREQUEST => $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => $headers, CURLOPT_TIMEOUT => 30]);
if ($body !== null) curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
return $data ?? [];
}
$job = api('POST', "$base/jobs/", $key, ['url' => 'https://example.com/report.docx', 'filename' => 'report.docx', 'format' => 'pdf'], ['Idempotency-Key: report-2026-11-pdf']);
$delay = 2;
for ($i = 0; $i < 60; $i++) {
$status = api('GET', "$base/jobs/{$job['jobId']}/", $key);
if (in_array($status['status'], ['completed', 'failed'], true)) break;
sleep($delay);
$delay = min($delay * 2, 10);
}
if ($status['status'] === 'completed') file_put_contents('report.pdf', file_get_contents($status['output']['downloadUrl']));cURL 与 Shell
需要安装 jq。在编写应用代码之前,用它测试密钥或格式非常方便。
JOB=$(curl -s -X POST 'https://maxscanner.app/api/v1/jobs/' \
-H "Authorization: Bearer $MAXSCANNER_API_KEY" -H 'Content-Type: application/json' \
-H 'Idempotency-Key: report-2026-11-pdf' \
-d '{ "url": "https://example.com/report.docx", "filename": "report.docx", "format": "pdf" }' | jq -r .jobId)
until STATUS=$(curl -s "https://maxscanner.app/api/v1/jobs/$JOB/" -H "Authorization: Bearer $MAXSCANNER_API_KEY"); \
echo "$STATUS" | jq -e '.status == "completed" or .status == "failed"' > /dev/null; do sleep 5; done
curl -s -o report.pdf "$(echo "$STATUS" | jq -r .output.downloadUrl)"OpenAPI 与 AI 编程助手
位于 https://maxscanner.app/openapi/maxscanner-v1.yaml 的 OpenAPI 3.1 描述文件可以配合你常用的生成器生成带类型的客户端。编程助手可以读取 https://maxscanner.app/llms.txt 和 https://maxscanner.app/ai/api.md,其中总结了相同的端点和规则。
常见问题
有官方 SDK 吗?
暂时没有。这个 API 规模不大,上面的示例或根据 OpenAPI 文件生成的客户端就足以覆盖。