苏心签

开发集成 · 聚合门户

API 文档中心

在站内完成导读、版本与示例索引；完整接口说明、参数表与错误码以独立文档站为准。

打开完整文档站 开放平台

完整参数表、错误码与 OpenAPI 以 doc.signneo.com 为准；本站数据见 src/data/api-docs-hub.ts。

快速开始

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

文档目录（外链索引）

以下路径为示例结构，上线前请与文档站实际路由对齐并修改 api-docs-hub.ts。

版本记录（示例）

版本 日期 摘要 文档
v2.4.0 2026-04-18 回调事件增加「签署节点完成」类型；模板 API 支持批量查询。 查看
v2.3.1 2026-03-02 鉴权令牌有效期策略调整；沙箱环境域名说明更新。 查看
v2.3.0 2026-01-20 发起流程接口字段「参与方」结构兼容说明。 查看

请求与联调示例

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

获取访问令牌（示例）

将 URL 与 JSON 字段名替换为文档站/OpenAPI 中的实际网关与参数。

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>"
  }'

创建签署流程（请求体片段）

以下为说明性 JSON，字段名需与当前版本 OpenAPI 一致。

{
  "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 前完成幂等落库，避免重复处理