跳到主要内容

通过文件发起合同

开始接入

准备工作

1、下载 SDK

SDK 下载说明

2、下载 DEMO

GitHub 仓库Coding 仓库

3、测试环境参数

您的第一个合同

1、打开 src/main/java/com/tencent/ess/config 下的 Config.java 修改第 14、16、19 行,设置 SecretId、 SecretKey、OperatorUserId;

2、打开 src/main/java/com/tencent/ess/byfile/下的 ByFileQuickStart.java 修改 personApproverName、personApproverMobile,设置姓名和手机号为自己的信息;

3、在 ideal 下打开文件 src/main/java/com/tencent/ess/byfile/ByFileQuickStart.java,右键执行 run 启动 main 函数

此时,给自己发起的第一个合同已经成功,控制台输出:

您创建的合同id为:
yDRxxxxxxxxxx

签署链接(请在手机浏览器中打开)为:
https://res.ess.tencent.cn/xxxx

请访问以下地址下载您的合同:
https://file.test.ess.tencent.cn/file/xxx

您可以查收短信或直接到 DEMO 小程序登录进行签署。Demo 小程序码如下:

三步完成正式环境接入

第一步:配置接入信息

打开根目录下的 src/main/java/com/tencent/ess/config/Config.java , 修改第 8、11 行,根据注释设置 EndPoint 为正式环境域名;修改第 14、16、19 行,设置 SecretId、 SecretKey、OperatorUserId;

第二步:通过文件发起合同

打开 src/main/java/com/tencent/ess/byfile 目录下的 ByFileQuickStart.java ,根据您的实际业务需求修改:

● $flowName:

合同名称,根据您的实际业务场景来自行定义,名称为不超过 200 个字符的中英文均可;

● $approvers:

approvers 指定了合同的签署方信息、合同签署方的签署控件等内容;

✈ 快速学习:关于签署人信息、签署控件的拼接

参数配置完成后,即可:

在 ideal 下打开文件 src/main/java/com/tencent/ess/byfile/ByFileQuickStart.java,右键执行 run 启动 main 函数,在正式环境一键发起合同

第三步:下载合同文件

第二步调用发起合同得到的 FlowId,会自动传入 DescribeFileUrls 函数用于获取合同链接,在浏览器中访问控制台打印出的链接即可下载合同文件。

至此,恭喜,您已完成腾讯电子签集成版正式环境的全部接入工作,您可以继续:

  • 将接入代码修改为接口并部署在服务端,提供给客户使用
  • 继续探索更高级的特性

正式接入

准备工作

1、准备 SecretId 和 SecretKey

2、准备 UserId

3、修改配置文件 设置 SecretId 、 SecretKey、UserId 为您正式环境下的信息

服务端正式环境接入

通过文件发起合同

服务端如果要集成文件发起合同功能,需要在接口(客户入参)、本地环境获取发起合同的相关参数,例如:

根据您的实际业务场景,封装通过文件发起合同函数(可以直接参考“第一个合同”中的代码);

例如:

public void createFlowByTFile((String operatorId, String inputFilePath, String flowName, ...)
{
// 根据您的实际业务逻辑构造签署人
ApproverInfo[] approvers = BuildApprovers();
...
// 发起合同
String[] resp = CreateFlowByFileDirectly.CreateFlowByFileDirectly(operatorId, flowName, approvers, inputFilePath);
System.out.println("您创建的合同id为: ");
System.out.println(resp[0]);
// 返回签署的链接
System.out.println("签署链接(请在手机浏览器中打开)为:");
System.out.println(resp[1]);
// 获取:flowId:resp[0];签署链接:resp[1]
// 您的其他业务逻辑
...
}

签署回调

签署回调简介:

通过签署回调,您可以在合同状态产生变化接受到来自电子签的通知,通知包含合同、签署人的信息等内容。

如您需要开通此功能,需提供一个能接受 HTTP POST 请求的回调地址,请确保该地址提供的服务可公网访问并正常处理回调通知。

电子签推送的回调内容有进行加密处理,在接受到回调通知后需用配置好的 key 进行解密。

设置签署回调:

1、回调解密代码路径 src/main/java/com/tencent/ess/callback/CallbackAes.java 修改 src/main/java/com/tencent/ess/callback/CallbackAes.java main 函数的:key 和 cryptedData

byte[] key = "***************".getBytes();
String cryptedData="****************";

2、在 ideal 下打开文件 src/main/java/com/tencent/ess/callback/CallbackAes.java,右键执行 run 启动 main 函数获得解密数据

3、在电子签控制台-应用管理配置回调地址和 key(正式接入时)

回调相关文档

相关接口文档

多文件上传

用 PDF 文件创建签署流程

查询文件下载 URL

自建应用集成开发者中心文档

自建应用集成

购买咨询
4006-808-062
4006-808-062