跳到主要内容

通过文件发起合同

开始接入

准备工作

1、下载 SDK

SDK 下载说明

2、下载 DEMO

GitHub 仓库Coding 仓库

3、测试环境参数

您的第一个合同

1、打开根目录下的 config.cs 修改第 5、6、9 行,设置 SecretId 、 SecretKey、OperatorUserId;

2、打开 bytefile 目录下的 quick-start.cs 修改 personName、personMobile,设置姓名和手机号为自己的信息,修改第 10 行设置函数名为 Main;

3、在项目根目录下执行以下命令启动脚本:

dotnet run

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

您创建的合同id为:
yDRxxxxxxxxxx

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

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

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

三步完成正式环境接入

第一步:配置接入信息

打开根目录下的 config.cs 修改第 5、6、9 行,设置 SecretId 、 SecretKey、OperatorUserId 为您正式环境下的信息;修改第 18、21 行,设置 EndPoint、FileEndPoint 为现网地址

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

打开 byfile 目录下的 quick-start.cs ,根据您的实际业务需求修改:

● $flowName:

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

● $approvers:

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

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

参数配置完成后,即可:

在项目根目录下执行以下命令启动脚本,在正式环境一键发起合同!

dotnet run

第三步:下载合同文件

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

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

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

正式接入

准备工作

1、准备 SecretId 和 SecretKey

2、准备 UserId

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

服务端正式环境接入

通过文件发起合同

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

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

例如:

public void CreateFlowByFile(string operatorUserId,
string flowName, ...)
{
// 根据您的实际业务逻辑构造签署人
ApproverInfo[] approvers = BuildApprovers();
...
// 发起合同


// 获取:FlowId;签署链接:SchemeUrl
// 您的其他业务逻辑
...
}

签署回调

签署回调简介:

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

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

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

设置签署回调:

回调解密代码路径 ess-dotnet-kit/callback/EssCallback.cs

修改代码 14、16 行 key 和 content 密文

// 传入CallbackUrlKey
string key = "***********";
// 传入密文
string content = "***********";

运行用例 Main 函数获得解密数据

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

回调相关文档

相关接口文档

多文件上传

用 PDF 文件创建签署流程

查询文件下载 URL

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

自建应用集成

购买咨询
微信客服
4006-808-062
4006-808-062