Python
项目说明
项目通过 pip 引入了腾讯云 sdk,补充了调用电子签第三方应用集成 API 所需要的内容,并提供了调用的样例。使用前请先在项目中导入腾讯云 sdk。
pip install --upgrade tencentcloud-sdk-python
通过 pip 安装腾讯云 sdk
通过 maven 获取腾讯云 sdk 是使用 Python SDK 的推荐方法,pip 是 Python 的依赖管理工具,支持您项目所需的依赖项,并将其安装到项目中。关于 pip 详细可参考 pip 官网。
安装 pip 详见官网 pip 官网
1.1 Windows 环境 Python 自带一个 ensurepip 模块,可以在 Python 环境中安装 pip。
# py -m ensurepip --upgrade
下载 Python 脚本 get-pip.py,它使用一些引导逻辑来安装 pip。 get-pip.py 下载
打开终端/命令提示符,cd 进入包含文件的 get-pip.py 文件夹并运行:
# py get-pip.py
1.2 Linux 环境
# python -m ensurepip --upgrade
下载 Python 脚本 get-pip.py,它使用一些引导逻辑来安装 pip。 get-pip.py 下载
打开终端/命令提示符,cd 进入包含文件的 get-pip.py 文件夹并运行:
# python get-pip.py
在控制台输入如下命令,如果能看到 Maven 相关版本信息,则说明 Maven 已经安装成功:
# pip list
tips:请注意,如果同时有 python2 和 python3 环境, python3 环境需要使用 pip3 命令安装。
- 使用 pip 导入依赖
# pip install --upgrade tencentcloud-sdk-python
目录文件说明
api
api 目录是对电子签第三方应用集成所有 API 的简单封装,以及调用的 Example。 如果需要 API 更加高级的功能,需要结合业务修改 api 的封装。
注意部分参数可能与用户配置的不一致,需要调整
byfile
byfile 目录是电子签第三方应用集成的核心场景之一 - 通过文件发起的快速上手样例。 ByFileQuickStart 一键使用文件发起流程:上传文件获取 fileId -> 创建签署流程 -> 获取签署链接 业务方可以结合自己的业务调整,用于正式对接。
bytemplate
byfile 目录是电子签第三方应用集成的核心场景之一 - 通过模板发起的快速上手样例。 ByTemplateQuickStart 一键使用模板 id 发起流程:创建流程 -> 创建电子文档 -> 等待文档异步合成 -> 开启流程 -> 获取签署链接 业务方可以结合自己的业务调整,用于正式对接。
common
用于构造默认电子签客户端调用实例, 以及一些公共参数的组装
config
里面定义调用电子签第三方应用集成 API 需要的一些核心参数。
testdata
blank.pdf 是一个空白的 pdf 用于快速发起合同的测试。