电子合同管理系统-对接文档
对接指南
API接口
认证
账户管理
新增开户或变更账户信息
请求授权企业静默签(线上)
请求授权企业静默签(线下)
线下授权文件上传
新增或变更企业代理签署人信息
请求授权企业代理签署人(线上)
请求授权企业代理签署人(线下)
获取账户
模版管理
添加-更新模版
预览模版-返回预览链接
预览模版-返回pdf文件流
合同管理
使用模版创建合同文档
根据合同文档编号查询合同文档的全部信息
取消合同文档签署
订阅接口
常见问题
回调/订阅通知
合同签署回调通知
企业信息变更订阅通知
本文档使用 MrDoc 发布
-
+
首页
添加-更新模版
# 接口描述 # 接口地址 `POST /admin/template/add` # 请求示例 ```javascript { "templateNumber": "", "templateDesc": "", "docBase64": "", "scope": "", "form": [ { "fieldName": "", "fieldValue": "", "fieldType": "" } ], "signatories": [ { "tag": "", "restrictSignatoryType": "", "signPos": [ { "posPage": "", "posX": 0, "posY": 0, "keyword": "", "type": 0 } ] } ] } ``` **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | | templateNumber|模版编号,首次增加时不要传递||false|string|| | templateDesc|模版描述||true|string|| | docBase64|模版内容base64||true|string|string(byte)| | scope|业务场景||false|string|| | form|模版表单||false|array|TemplateForm| | fieldName|||false|string|| | fieldValue|字段可选值,具体根据field_type来确认格式||false|string|| | fieldType|字段类型:textarea text number....||false|string|| | signatories|模版签名位置标记||false|array|TemplateSignatory| | tag|标记符||false|string|| | restrictSignatoryType|模版签署人类型限制,为空不限制,可用值:PERSONAL,CORPORATE,PLATFORM||false|string|| | signPos|预设的位置||true|array|SignPos| | posPage|印章所在页码,坐标与骑缝章必传,支持范围页码(1-3,4,5)||false|string|| | posX|印章x坐标,坐标必传||false|number(float)|| | posY|印章y坐标,坐标与骑缝章必传||false|number(float)|| | keyword|关键字||false|string|| | type|0为坐标,1为关键字,2为骑缝章;默认为0||false|integer(int32)|| # 响应参数 | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |code|返回标记:成功标记=0,失败标记=1|integer(int32)|integer(int32)| |msg|返回信息|string|| |data||Template|Template| | id||integer(int64)|| | templateNumber|模版编号|string|| | templateDesc|模版描述|string|| | templateType|模版类型;pdf、word,可用值:PDF,DOCXF,DOCX|string|| | sceneId|存证场景ID|string|| | scope|业务场景|string|| | fieldCount|模版字段数量|integer(int32)|| | delFlag|删除标记,1:已删除,0:正常|string|| | createBy|创建人|string|| | createTime||string(date-time)|| | updateBy||string|| | updateTime||string(date-time)|| | deptId|部门ID|integer(int64)|| | companyId|公司ID|integer(int64)|| | client||string|| |requestId||string|| |ok||boolean|| # 响应示例 ```javascript { "code": 0, "msg": "", "data": { "id": 0, "templateNumber": "", "templateDesc": "", "templateType": "", "sceneId": "", "scope": "", "fieldCount": 0, "delFlag": "", "createBy": "", "createTime": "", "updateBy": "", "updateTime": "", "deptId": 0, "companyId": 0, "client": "" }, "requestId": "", "ok": true } ```
admin
2024年8月28日 17:42
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码