契约锁 API
  1. 模板管理
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
      • 合同管理-用文件添加合同文档
      • 合同管理-多文件添加合同文档
      • 合同管理-用模板添加合同文档
      • 合同管理-发起合同
      • 合同管理-抄送合同
      • 合同管理-修改签署方
      • 合同管理-添加签署方
      • 合同管理-浏览页面
      • 合同管理-合同详情
      • 合同管理-获取合同列表
      • 合同管理-下载合同与附属文件
      • 合同管理-下载合同文档
      • 合同管理-强制结束合同
      • 合同管理-上传强制结束附件
      • 合同管理-合同文档添加水印
      • 合同管理-合同延期
      • 合同管理-获取合同操作记录
      • 合同管理-获取合同与附属文件下载链接
    • 签署服务
      • 签署服务-公章签署
      • 签署服务-签署法人章
      • 签署服务-审批
      • 签署服务-合同催签
      • 签署服务-签署页面
      • 签署服务-预签署页面
      • 签署服务-获取短链接
      • 签署服务-撤回/作废合同
      • 签署服务-自定义文件作废合同
      • 签署服务-自定义模板文件作废合同
      • 签署服务-签署作废合同
      • 签署服务-签署个人签名
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
        GET
      • 模板管理-模板详情
        GET
      • 模板管理-模版预览页面
        GET
      • 模板管理-创建Word模板
        POST
      • 模板管理-编辑模板
        POST
      • 模板管理-管理模板状态
        POST
      • 模板管理-下载模板
        GET
      • 模板管理-删除模板
        GET
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 模板管理

模板管理-创建Word模板

POST
/v3/template/createbyword
调用此接口可创建企业文件模板,仅支持上传文件类型为docx且小于10M的文件。制作word模板请参考维护文件模板 ,word模板只支持设置文本类型参数。 新建模板的状态默认启用,使用范围默认为所有人。
此接口支持并发、不支持幂等(重复调用此接口会生成多份相同模板)。

请求参数

Header 参数
x-qys-open-accesstoken
string 
可选
默认值:
{{x-qys-open-accesstoken}}
x-qys-open-timestamp
string 
可选
默认值:
{{x-qys-open-timestamp}}
x-qys-open-nonce
string 
可选
默认值:
{{x-qys-open-nonce}}
x-qys-open-signature
string 
可选
默认值:
{{x-qys-open-signature}}
Body 参数multipart/form-data
title
string 
模板名称
必需
示例值:
开放平台Word模板{% mock 'timestamp' , 'ms' %}
file
file 
必需
模板文件,仅支持docx格式,小于10MB
tenantName
string 
可选
公司名称,指定模板所属公司,未传递时默认为平台方名称
renameRepeatParam
string 
可选
模板中若有重名参数,是否自动重命名重名参数,自动重命名即按照 “参数名” + “数字” 的规则命名,示例 “金额1、金额2、金额3…”;默认不自动重命名参数
managersInfo
string 
可选

模板管理员,默认为企业模版管理员,可设置具体公司内的人员,List 的json数组字符串

rangeInfo
string 
可选

模板使用范围,默认为所有人,允许自定义设置具体的人,List 的json数组字符串

示例值:
,
allUser
string 
可选
此模板使用范围是否设置为所有人,默认为false;为true且rangeInfo参数为空时,设置所有人可使用
status
string 
可选
模板状态,默认为启用, ENABLED(启用)、DISABLE(停用)

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.qiyuesuo.com/v3/template/createbyword' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--form 'title="开放平台Word模板{% mock '\''timestamp'\'' , '\''ms'\'' %}"' \
--form 'file=@""'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
result
object (TemplateReponse) 
必需
id
string 
模板ID
可选
name
string 
模板名称
可选
state
boolean 
是否启用
可选
createTime
string 
创建时间
可选
格式为:yyyy-MM-dd HH:mm:ss
parameters
array[object (TemplateParamReponse) {6}] 
模板参数
可选
示例
{
  "result": {
    "id": "3053233776273391772",
    "name": "开放平台Word模板{{__Random(10,99,)}}",
    "state": false,
    "createTime": "2023-01-18 15:40:54"
  },
  "code": 0,
  "message": "SUCCESS"
}
上一页
模板管理-模版预览页面
下一页
模板管理-编辑模板
Built with