BetterOCR 开放平台

用 REST API 把单证抽取接进你的业务系统，用 MCP 把文档智能接进你的 AI Agent，用 Webhook 实时接收处理事件。完整端点契约见 openapi.json 与在线 Swagger。

认证

API Key / JWT

MCP

7 个文档智能工具

Webhook

8 类事件 · HMAC 签名

SDK

TypeScript 零依赖

1. 认证

管理角色在控制台「开发者门户」签发 API Key（scope：extract /qaread，可设滚动配额），所有服务端调用带X-API-Key头。Key 仅创建时展示一次。

curl -X POST /api/v1/apikeys \
  -H "Authorization: Bearer <JWT>" -H "Content-Type: application/json" \
  -d '{"name": "erp-integration", "scopes": ["extract", "read"]}'

2. 快速开始：上传 → 轮询 → 取字段

# 1) 上传单证
DOC=$(curl -s -X POST /api/v1/documents/upload \
  -H "X-API-Key: $KEY" -F "file=@invoice.pdf")
ID=$(echo $DOC | python3 -c "import json,sys; print(json.load(sys.stdin)['id'])")

# 2) 轮询至终态 (extracted / reviewing / approved / rejected / failed)
curl -s /api/v1/documents/$ID -H "X-API-Key: $KEY"

# 3) 取结构化字段（可加 ?with_provenance=true 带字段级溯源）
curl -s /api/v1/documents/$ID/extractions -H "X-API-Key: $KEY"

自定义单证类型：POST /extraction-configs（字段即 schema，LLM 按此抽取）；当前已内置汽车购买合同 / 学生意外险投保单 / 事故认定书 / 财产保全申请书 / 鉴定申请书等类型。

3. MCP（AI Agent 接入）

端点 /api/v1/mcp（JSON-RPC 2.0，Accept: text/event-stream 时以 SSE 帧返回）。 7 个工具：parse_document、classify、extract_fields、qa、split_document、summarize、validate。

# tools/call：从合同文本抽字段
curl -s /api/v1/mcp -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":3,"method":"tools/call",
       "params":{"name":"extract_fields",
                 "arguments":{"text":"出卖人：河南迪行新能源汽车有限公司 合同编号：TT028427"}}}'

MCP host 配置：

{
  "mcpServers": {
    "adp": {
      "url": "/api/v1/mcp",
      "headers": {
        "X-API-Key": "adp_…"
      }
    }
  }
}

4. Webhook 事件回调

订阅 8 类事件（uploaded / completed / extracted / reviewing / approved / rejected / failed / delivered）。回调头X-ADP-Signature = hex(hmac_sha256(secret, body))，请按原始 body 验签。失败自动指数退避重试，投递台账与手动重投见/webhooks/{id}/deliveries。

curl -X POST /api/v1/webhooks -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "erp-callback", "url": "https://your-system.com/adp-hook",
       "events": ["document.extracted", "document.failed"],
       "secret": "your-hmac-secret"}'

5. 错误码与限额

HTTP	场景
401	凭据缺失/无效
402	套餐配额耗尽（body 带 dimension/used/limit/upgrade_url）
403	租户被停用
422	参数校验失败
429	限流（边缘 10r/s + 按套餐 + Key 滚动配额）

6. 更多

在线调试：{baseUrl}/docs；全量契约：openapi.json
TypeScript SDK：sdk/typescript（零依赖，JWT/API Key 双认证，终态轮询）
SSE 实时事件流：/api/v1/events?topic=document_status
企业对接疑问请联系销售索取完整集成手册

← 返回首页