接口描述
通过文件直传地址创建模板，创建模板后上传文件，上传方法请参考：文件流上传方法
PDF模板文件如何制作请点击查看PDF模板文件制作说明
注意：
（1）上传的文件大小不要超过40M，详见文件大小规则说明
（2）因Windows操作系统中文件名称不支持个别特殊字符，现调整fileName字段不支持以下9个字符
/ \ : * " < > | ？以及所有emoji表情，详见文件名称特殊字符限制
（3）上传的文件类型规则描述，详见文件类型规则说明
点击查看具体更新日志
API在线调试
可通过API在线调试工具使用接口功能，入口：通过上传方式创建模板
接口
/v1/docTemplates/createByUploadUrl
请求方式
POST
请求头
提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权
请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
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 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 |
contentMd5 | string | 是 | body | 先计算文件md5值，在对该md5值进行base64编码， （1）获取示例：【请点击】 （2）可使用E签宝官网工具进行计算【请点击】   | |
contentType | string | 是 | body | 目标文件的MIME类型，支持： （1）application/octet-stream （2）application/pdf 注意，后面文件流上传的Content-Type参数要和这里一致，不然就会有403的报错 | |
fileName | string | 是 | body | 文件名称，必须带扩展名如:.pdf,.doc,.docx （1）该字段的文件后缀名称和真实的文件后缀需要一致。比如上传的文件类型是word文件，那该参数需要传“xxx.docx”，不能是“xxx.pdf” （2）文件名称不支持以下9个字符：/ \ : * " < > | ？ | |
convert2Pdf | boolean | 是 | body | 是否需要转成pdf，如果模板文件为.doc/.docx 传true，为pdf传false; 注意：如果本身就是PDF文件，该参数必须传false，否则在【通过模板创建文件】的时候不能填充内容 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码，0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
templateId | string | 否 | 模板id | |
uploadUrl | string | 否 | 文件直传地址，需要用此上传地址使用put方式上传文件，只有文件上传后模板才可用 注：uploadUrl可以重复使用，但是只能传一样的文件，有效期一小时 |
请求示例
POST https://openapi.esign.cn/v1/docTemplates/createByUploadUrl
{
"contentMd5":"cTNpB5QZ8fAP9jScrV8teA==",
"contentType":"application/octet-stream",
"fileName":"测试模板.docx",
"convert2Pdf":true
}
响应示例
{
"code": 0,
"data": {
"templateId": "adfadfadfweweafadfadfa",
"uploadUrl": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/1111563786/5d45dc91-470b-41dd-8e6f-9663ee9641db/%E6%89%B9%E9%87%8F%E5%AF%BC%E5%85%A5-%E9%94%99%E8%AF%AF%E6%95%B0%E6%8D%AE.xls?Expires=1559294245&OSSAccessKeyId=LTAIdvHfiVrzDKbE&Signature=hBEuUHAC7TVxzRIr/BihG1m3QEQ%3D"
},
"message": "成功"
}错误码
错误码 | 错误描述 | 解决方案 |
1430011 | 模板文件未转换完成 | 如果模板是PDF的话，convert2Pdf 必须传false，如果是传true就会报这个错 |
401 | 1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的 |
我要纠错