跳到主要内容

通过文件发起合同

开始接入

准备工作

1、下载 SDK

SDK 下载说明

2、下载 DEMO

GitHub 仓库Coding 仓库

您的第一个合同

1.打开根目录下的 config.php 修改设置 SecretId 、SecretKey、AppId、ProxyOrganizationOpenId、ProxyOperatorOpenId、TemplateId;

2.打开 byfile 目录下的 quick-start.php 修改 personName、personMobile,设置姓名和手机号为自己的信息;

3.在项目根目录下执行以下命令:

php byfile/quick-start.php

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

您的控制台入口为:

https://beta.ess.tencent.cn/xxxxxxxxxxxxxxxxxxxxxxx

您创建的合同 id 为:

yDRxxxxxxxxxx

签署链接(请在手机浏览器中打开)为:

https://test.essurl.cn/xxx

请访问以下地址下载您的合同:

https://file.test.ess.tencent.cn/file/xxx

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

三步完成正式环境接入

第一步:配置接入信息

打开根目录下的 config.php 修改设置 SecretId 、SecretKey、AppId、ProxyOrganizationOpenId、ProxyOperatorOpenId、TemplateId 为您正式环境下的信息;修改设置 EndPoint、FileEndPoint 为现网地址

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

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

  • filePath: 合同文件,根据实际场景替换文件;
// 定义文件所在的路径
$filePath = __DIR__ . "/../testdata/test.pdf";
  • flowName: 合同名称,根据您的实际业务场景来自行定义,名称为不超过 200 个字符的中英文均可;

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

  • 快速学习:关于签署方、签署控件相关信息:

签署方、签署控件相关信息

参数配置完成后,即可: 在项目根目录执行以下命令,在正式环境一键发起合同!

php byfile/quick-start.php

第三步:下载合同文件

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

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

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

正式接入

准备工作

1.准备 SecretId 和 SecretKey

准备 SecretId 和 SecretKey

2.准备 AppId、ProxyOrganizationOpenId、ProxyOperatorOpenId

名称说明(重要)

企业认证完成授权

3.修改配置文件

设置 SecretId 、 SecretKey、AppId、ProxyOrganizationOpenId、ProxyOperatorOpenId 为您正式环境下的信息

服务端正式环境接入

通过文件发起合同

服务端如果要集成文件发起合同功能,需要在接口(客户入参)、本地环境获取发起合同的相关参数,例如: 根据您的实际业务场景,封装通过文件发起合同函数(可以直接参考“第一个合同”中的代码); 例如:

 {
// 根据您的实际业务逻辑构造签署人
$approvers = [];
array_push($approvers, BuildPersonApprover($personName, $personMobile));
...
// 发起合同
...

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

签署回调

签署回调简介:

通过签署回调,您可以在合同状态产生变化接受到来自电子签的通知,通知包含合同、签署人的信息等内容。如您需要开通此功能,需提供一个能接受 HTTP POST 请 求的回调地址,请确保该地址提供的服务可公网访问并正常处理回调通知。

配置回调参数

签署回调回调相关文档

相关接口文档

文件上传

通过文件创建签署流程

根据签署流程信息批量获取资源下载链接

第三方应用集成文档

第三方应用集成文档

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