添加未填充变量的文件模板
接口说明
[!NOTE]
开发者通过可视化的制作合同模板页面(免登录)来添加各类控件,后续可通过【签约发起-模板类API】接口生成最终需要签署的文件。创建或修改文件模板(PDF或Word),创建好的模版可以登录君子签企业账号后台查看。【注意事项】
1、沙箱环境和正式环境不互通,需要分别制作,合同模板分为PDF和Word文件两种类型的模板,制作模板如下图:
http请求方式
[!NOTE]
POST application/x-www-form-urlencoded
http请求地址
[!NOTE]
$SERVICE_URL/v2/tmpl/tmplPdfSave #其中$SERVICE_URL为生产或测试的地址
http请求参数
除公共必填参数外,还需要传以下参数
参数 | 类型 | 是否必填 | 默认值 | 说明 |
---|---|---|---|---|
templateName | string | * | 模板名称 不超过50字符;当templateNo为空时必传 | |
templateNo | string | ? | 模版id (注:修改模板时传入) | |
file | MultipartFile | * | 文件模板(支持PDF或word),且以.pdf或.doc或.docx结尾 | |
attachFile | MultipartFile[] | ? | 模板附件 |
代码实现
JAVA实现
Map<String, Object> params = bodyParams;
String url = SERVICE_URL + "/v2/tmpl/tmplPdfSave";
params.put("templateName", "服务协议");
params.put("file", new File("d:\\唐\\行总合同.pdf"));
String str = HttpClientUtils.init().getPost(url, null, params, true);
System.out.println(str);
http返回参数
[!NOTE]
返回response为application/json的数据,其字段说明如下:
参数 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
success | boolean | * | 成功true;异常false |
data | json | 响应内容json |
data参数说明
参数 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
templateName | string | 模板名称 | |
templateNo | string | 模板编号 | |
url | string | 模版编辑访问链接(注:1、模板保存后连接地址即失效;2、模板未保存时,链接地址2小时之内有效) |
[!NOTE]
返回结果,参考:
//正确响应:
{"data":{"success":true,"templateName":"服务协议","templateNo":"4ED987BE26832","url":"https://web.junziqian.com/advancedVeE"},"success":true}
//错误响应:
{"msg":"签约文件不能为空","resultCode":"HTTP_PARAM_ERROR","success":false}