API 文档中心

快速开始

1. 在开放平台完成开发者/企业认证，创建应用并记录 AppId。
2. 配置回调 URL、IP 白名单（如有）与密钥轮换策略。
3. 使用沙箱环境获取访问令牌，按文档完成首条「创建签署流程」联调。
4. 验收通过后切换生产域名与凭证，并接入监控与告警。

文档目录

以下为文档站章节索引，点击将在新窗口打开完整说明；路径以线上文档站为准。

• 鉴权与安全

  访问令牌、签名算法、IP 限制与重试幂等建议。

  /auth/overview

• 文件与模板

  上传、模板填充、附件策略与下载权限。

  /files/templates

• 签署流程

  创建流程、签署方、顺序与状态查询。

  /sign/flows

• 回调与验签

  事件订阅、回调体结构、验签与重放防护。

  /webhooks/verify

• 错误码与排障

  业务错误码、HTTP 状态与常见问题。

  /reference/errors

• 限流与配额

  租户级 QPS、并发与配额说明。

  /limits/quota

版本记录

请求与联调示例

以下为演示用途，请勿直接用于生产；字段与路径以文档站为准。

curl -sS -X POST "https://<API_HOST>/oauth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "<YOUR_APP_ID>",
    "client_secret": "<YOUR_APP_SECRET>"
  }'

{
  "subject": "采购合同-2026-Q2",
  "templateId": "tpl_8f3c2a1b",
  "signers": [
    { "role": "甲方", "name": "张三", "mobile": "13800138000" },
    { "role": "乙方", "name": "李四", "email": "signer@example.com" }
  ],
  "callbackUrl": "https://your-domain.com/api/sign/callback"
}

# 1) 读取文档规定的签名头，例如 X-Signneo-Signature / X-Signneo-Timestamp
# 2) 使用平台下发的公钥或对称密钥验签
# 3) 校验 timestamp 与业务 nonce（若文档要求）
# 4) 返回 200 前完成幂等落库，避免重复处理

API 常见问题