查询e签宝官网模板信息

更新时间：2022-06-16 15:59:08

接口描述

通过此接口查询调用的appid所对应e签宝官网企业主体下的模板基础信息。

e签宝官网制作模板手册参考：【请点击跳转】

接口地址

/v3/flow-templates/basic-info?pageNum=XX&pageSize=XX

请求方式

GET

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接。

方式一：请求签名鉴权

请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	否	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权

当安全接入选择OAuth2.0鉴权方式。

请求参数

参数名称	类型	必选	参数类型	参数说明
pageNum	query	否	int	查询页码，不传默认第1页，起始值：1
pageSize	query	否	int	分页大小，不传默认10条，最大值：100

响应参数

展开全部参数参数名称				类型	必选	参数说明
code				int	是	业务码，0表示成功
message				string	是	信息
data				object	否	业务信息
	flowTemplateBasicInfos			array	否	流程模板基本信息列表
		flowTemplateId		string	否	流程模板编号
flowTemplateName		string	否	流程模板名称
docTemplates		array	否	文件模板信息
		docTemplateId	string	否	文件模板id 注意：该参数为接口中使用的模板id
		docTemplateName	string	否	文件模板名称
total			integer	否	数据总条数

响应参数对应官网位置截图

请求示例

GET https://openapi.esign.cn/v3/flow-templates/basic-info?pageNum=1&pageSize=5

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "flowTemplateBasicInfos": [
            {
                "flowTemplateId": "7f3d414144de4633a1e0a3644fc7bab3",
                "flowTemplateName": "流程模板名称3",
                "docTemplates": [
                    {
                        "docTemplateId": "1bf05d2600034aa083eef31b6724e001",
                        "docTemplateName": "test001.pdf"
                    },
                    {
                        "docTemplateId": "30e2dce56e414890b14382ae09812002",
                        "docTemplateName": "test002.pdf"
                    },
                    {
                        "docTemplateId": "f94f4d87938e4aaa898b2b2820fa4002",
                        "docTemplateName": "test003.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "6f64eb48583a4febb9b99147b47a8ab2",
                "flowTemplateName": "流程模板名称2",
                "docTemplates": [
                    {
                        "docTemplateId": "104f9adcce30429195ba526e45cd65001",
                        "docTemplateName": "PDFTemplate001.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "b188f6064bf74657a580424c97ed2ab1",
                "flowTemplateName": "流程模板名称1",
                "docTemplates": [
                    {
                        "docTemplateId": "61b839c616cb43aaa2a92c99c50ef001",
                        "docTemplateName": "测试签署文件001.pdf"
                    },
                    {
                        "docTemplateId": "e92382ea2b3f4880833c2904571f8002",
                        "docTemplateName": "测试签署文件002.pdf"
                    }
                ]
            }
        ],
        "total": 3
    }
}