接入流程介绍

了解签签开放平台集成开发全流程，快速找到你所需要的信息。

了解电子签

了解电子签的基本概念与开发须知，方便快速开始。

对接准备

获取接入凭证、配置回调地址，完成对接前的准备工作。

开发接口

按开发流程调用模板、合同等接口，完成联调。

上线使用

联调通过后切换生产环境，正式发起与签署合同。

了解电子签

建议先阅读本接入指南，了解合同发起、签署方、盖章与状态等基本概念，以及开发前须知。可从签署方、盖章规则与位置、状态等章节快速入门。

对接准备

apiKey 需联系我们开通，不能自助申请。开通时请一并提供回调地址，签签会分配接口基址、apiKey 与回调密钥。详见接入凭证与调用约定。

开发接口

按业务顺序调用开放接口：查询模板、创建合同、查询进度、下载文件或撤回。可对照API概览查看接口清单，并使用API在线调试进行联调。

典型步骤：

1. 使用分配的 apiKey 调用接口。发起人已绑定在该 key 上，请求中无需传递。
2. 使用模板时，先查询模板，取得 templateId、templateSignatoryId 和发起方控件 ID。
3. 创建合同。成功后保存 contractId 与 signUrl，由接入方将链接发给签署方。
4. 通过合同详情查询进度，或接收状态回调。
5. 签署完成后下载合同 PDF。进行中的合同可撤回。

上线使用

联调通过后，切换到生产环境的接口基址与正式 apiKey。一份合同对应一条签署链接，全体签署方共用。链接形如 https://h5.xwkc.com/{短码}。

失效时刻取以下三者中最早的一个：创建后 30 天、合同截止时间、合同离开进行中的时刻。离开进行中包括已完成、已撤回、已拒签、已作废、已过期。平台不代发短信或微信，请由接入方自行通知签署方。