基于模板创建合同文件

接口使用前需要先在签盾saas平台创建模版，
*模版的签署区组件设置无效，需要在合同发起时指定印章签署区

企业发起需要权限：
1.get_corp_template：授权允许获取企业的模板数据
或个人：
1.get_psn_template：授权允许获取个人的模板数据

请求头格式

具体请求头参数，请查看公共请求格式

请求参数

Body 参数application/json

docTemplateId

string

模板ID

必需

在SAAS中创建查看

fileName

string | null

发起的合同名

可选

无需文件后缀。在合同预览、下载、存证时展示的文件名。未填则系统随机生成

isCheck

boolean

是否校验组件编码

可选

开启后，如果传入不存在的组件编码则会报错

默认值:

false

components

array [object {2}] | null

可选

componentId

string

组件编码

必需

componentKey

string

组件值

必需

示例

{
    "docTemplateId": "PTC_20240521170732JPSuIIegDRgwpn",
    "fileName": "租房合同",
    "components": [
        {
            "componentId": "240521YDw23a8WhE",
            "componentKey": "文本123123"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

string

必需

msg

string

必需

result

object | null

必需

fileCode

string

文件Code

必需

文件唯一编码（发起时用这个）

filename

string

文件名

必需

文件名，如果上传时未传‘filename’参数则系统随机生成

fileUrl

string

文件地址

必需

fileViewUrl

string

文件预览地址

必需

文件预览地址，有访问时效（预览时用这个）

fileType

string

文件类型

必需

文件类型（pdf:PDF, word:Word, image:图片, audio:音频, video:视频, package:压缩包）

success

boolean

必需

示例

{
    "code": "200",
    "msg": "成功",
    "result": {
        "fileCode": "FC_20230414105522daGzUlQganifJBP",
        "filename": "R-C.pdf",
        "fileUrl": "independent-signature-pri-dev:contract/pdf/2023/4/14/20230414105522tvuiKJfyYBOUMoxJFstv.pdf",
        "fileViewUrl": "https://independent-signature-pri-dev.devqd.work/contract/pdf/2023/4/14/20230414105522tvuiKJfyYBOUMoxJFstv.pdf?Expires=1681444524&OSSAccessKeyId=LTAI4FmuFfVmpcEJ8Dv3jZY5&Signature=T0VOfirhhbz%2BaEt6RBP39phvU%2Fc%3D",
        "fileType": "pdf"
    },
    "success": true
}

请求头格式#

请求参数

示例代码

返回响应

请求头格式