查询e签宝官网模板信息

更新时间：2022-10-18 14:06:33

接口描述

通过此接口查询调用的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": "06be81d0c****cba54386a53",
                "flowTemplateName": "流程模板名称3",
                "docTemplates": [
                    {
                        "docTemplateId": "fe395be****288b1cc9",
                        "docTemplateName": "test001.pdf"
                    },
                    {
                        "docTemplateId": "73e000cb*******63",
                        "docTemplateName": "test002.pdf"
                    },
                    {
                        "docTemplateId": "fae8eb91*****81c2f2ed6",
                        "docTemplateName": "test003.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "e7883cd****cce12a9c",
                "flowTemplateName": "流程模板名称2",
                "docTemplates": [
                    {
                        "docTemplateId": "3a638f3*****55f5d",
                        "docTemplateName": "测试模板1.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "ef61a61b4e2*****d8813ec",
                "flowTemplateName": "流程模板名称1",
                "docTemplates": [
                    {
                        "docTemplateId": "95364cb80*******a603a",
                        "docTemplateName": "测试模板2.pdf"
                    }
                ]
            }
        ],
        "total": 3
    }
}