跳到主要内容

创建合同对比web页面

1. 接口描述​

接口请求域名： ess.tencentcloudapi.com 。

接口（CreateContractDiffTaskWebUrl）用于创建合同对比的可嵌入web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。 注：本接口生成的web页面暂不支持设置本企业嵌入式页面主题配置

未跳过上传确认的嵌入页面长相如下： image 跳过上传确认的嵌入页面长相如下： image

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数​

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateContractDiffTaskWebUrl。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。使用此接口时，必须填写userId。

注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
SkipFileUpload是Boolean是否跳过文件上传确认页。
当该参数值为false时，OriginalFileResourceId和DiffFileResourceId参数不需要传值，需要在生成的web页面中上传对比文件；
当该参数值为true时，OriginalFileResourceId和DiffFileResourceId参数必填，生成的web页面将跳过上传页面显示对比结果。
示例值：false
OriginalFileResourceId否String需要对比的原合同文件资源ID，通过UploadFiles接口获取文件资源ID。
示例值：yDttXUUckpx90i17UxPpcHHE1VDpNJPW
DiffFileResourceId否String需要对比的新合同文件资源ID，通过UploadFiles接口获取文件资源ID。
示例值：yDttXUUckpx90i1xUxPpcHHyPdyqVErm
UserData否String调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。

在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
示例值：QmFzZTY0IEJhc2U2NCA
Tags.N否Array of Tag标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。

3. 输出参数​

参数名称类型描述
TaskIdString接口返回的合同对比任务ID，可以调用接口获取合同对比结果web页面查看对比任务的结果。
当SkipFileUpload参数为true时才会返回值，否则为空。
示例值：yDt31UUckpx91cypUyoAic6wP2oyarMN
WebUrlString合同对比嵌入式web页面链接，有效期：5分钟
链接仅能使用一次
示例值：https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDtthUUckpx9l14eUy8nTBEypH6h1yKt&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF
UserDataString调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
示例值：QmFzZTY0IEJhc2U2NCA
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 创建合同对比web页面​

输入示例​

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContractDiffTaskWebUrl
<公共请求参数>

{
    "Operator": {
        "UserId": "yDw9iUUgyg36ykr3Ux4GQpt1FPWYQOZC"
    },
    "SkipFileUpload": true
}

输出示例​

{
    "Response": {
        "RequestId": "s1748574341239597750",
        "TaskId": "",
        "WebUrl": "https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDtthUUckpx9l14eUy8nTBEypH6h1yKt&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF"
    }
}

示例2 创建合同对比web页面 - 跳过文件上传确认页​

输入示例​

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContractDiffTaskWebUrl
<公共请求参数>

{
    "Operator": {
        "UserId": "yDw9iUUgyg36ykr3Ux4GQpt1FPWYQOZC"
    },
    "OriginalFileResourceId": "yDttXUUckpx90i17UxPpcHHE1VDpNJPW",
    "DiffFileResourceId": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm",
    "SkipFileUpload": true,
    "UserData": "QmFzZTY0IEJhc2U2NCA",
    "Tags": [
        {
            "TagKey": "key1",
            "TagValue": "value1"
        }
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "s1748937464610832514",
        "TaskId": "yDt31UUckpx91cypUyoAic6wP2oyarMN",
        "WebUrl": "https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDt31UUckpx9196lUxKwEYgzw4fEWCom&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF&businessType=TASK_ID&businessId=yDt31UUckpx91cypUyoAic6wP2oyarMN",
        "UserData": "QmFzZTY0IEJhc2U2NCA"
    }
}

5. 错误码​

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码描述
FailedOperation操作失败。
InternalError.Db数据库异常。
InvalidParameter参数错误。
更多开发者交流反馈