查询模板文件上传状态

更新时间:2022-02-28 16:38:58

接口描述

查看所上传模板文件的当前状态,本接口支持轮询。

当接口返回的 模板文件上传状态 templateFileStatus 值为 2 或 3 时,此模板文件才可以被正常填充内容。

接口地址

/v1/docTemplates/{templateId}/getBaseInfo

请求方法

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鉴权方式请点击查阅详情,请求头入参示例如下:

参数名称

类型

必选

参数说明

X-Tsign-Open-App-Id

string

应用ID

X-Tsign-Open-Token

string

通过获取鉴权Token接口返回

Content-Type

string

application/json; charset=UTF-8


请求参数

参数名称

类型

必选

参数类型

参数说明

templateId

string

path

模板id,该参数需放在请求地址里面,可以参考【请求示例】

响应参数

展开全部参数参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

信息

data

object

业务信息

templateId

string

模板id

templateName

string

模板名称

templateFileStatus

string

模板文件上传状态。

0-未上传

1-未转换成PDF

2-已上传成功

3-已转换成PDF

fileSize

long

模板文件大小

createTime

int64

创建时间,Unix时间戳(毫秒级)

updateTime

int64

更新时间,Unix时间戳(毫秒级)

请求示例  

GET https://openapi.esign.cn/v1/docTemplates/【传入模板id】/getBaseInfo

响应示例

{
	"code": 0,
	"message": "成功",
	"data": {
		"templateId": "78f86dfe01f64d0382a05fb3ff36a9be",
		"fileSize": 324292,
		"templateName": "个人借贷模板",
		"templateFileStatus": 1,
		"createTime": 1546508768000,
		"updateTime": 1546508768000
	}


我要纠错