API概览

以下为当前开放的标准接口清单。点击接口名称进入详情；联调可使用API在线调试。

完整 URL 为 {baseUrl} + 接口路径。鉴权、响应结构与分页约定见调用约定。

推荐调用顺序

1查询模板

可选；模板发起时先查列表/详情

2创建合同

文件地址或模板，拿到 contractId

3获取签署链接

取 signUrl 并通知签署方

4跟踪进度

合同详情查询或状态回调

5下载 / 撤回

完成后取 PDF，进行中可撤回

1. （可选）模板列表 / 模板详情 — 使用模板发起时先查模板
2. 创建合同 — 获得 contractId（创建响应中也会返回 signUrl）
3. 获取合同签署链接 — 需要再次下发或补发链接时调用
4. 合同详情 或 状态回调 — 跟踪进度
5. 下载合同 — 签署完成后取 PDF；进行中可撤回

模板管理

接口名称	方法	接口地址	功能说明
模板列表	GET	/open/v1/templates	分页查询当前企业已启用模板
模板详情	GET	/open/v1/templates/{templateId}	查询模板签署方与控件

模板在签签企业端维护，开放接口只读。

合同管理

接口名称	方法	接口地址	功能说明
创建合同	POST	/open/v1/contracts	按文件地址或模板创建，返回签署链接
合同列表	GET	/open/v1/contracts	分页查询当前 key 创建的合同
合同详情	GET	/open/v1/contracts/{contractId}	查询合同状态与签署方进度
下载合同	GET	/open/v1/contracts/{contractId}/file	下载最新 PDF 文件流
获取合同签署链接	GET	/open/v1/contracts/{contractId}/sign-url	获取进行中合同的签署链接
撤回合同	PATCH	/open/v1/contracts/{contractId}	撤回进行中的合同

说明：

• 创建合同须且只能使用 fileUrl 与 templateId 其中之一。
• 列表与详情仅返回当前 apiKey 创建的合同。
• 下载成功时响应为 PDF 流，失败时为 JSON 错误体。
• 签署链接仅在合同为 signing 且未失效时可获取。

回调事件

接口名称	方法	接口地址	功能说明
状态回调	POST	开通时配置的 HTTPS 地址	合同或签署方状态变化时平台主动推送

回调地址与回调密钥在开通时配置，创建合同请求中不传递。验签与重试规则见回调文档。

相关工具

工具	说明
错误码查询	按 HTTP 状态或 code 查询含义
获取签章位置	辅助估算文件发起时的盖章坐标
API在线调试	选择接口后直接发起调用