1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
接口（CreateContractDiffTaskWebUrl）用于创建合同对比的可嵌入web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。
注：本接口生成的web页面暂不支持设置本企业嵌入式页面主题配置
未跳过上传确认的嵌入页面长相如下：
跳过上传确认的嵌入页面长相如下：
默认接口请求频率限制：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 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 接口返回的合同对比任务ID，可以调用接口获取合同对比结果web页面查看对比任务的结果。 当 SkipFileUpload参数为true时才会返回值，否则为空。示例值：yDt31UUckpx91cypUyoAic6wP2oyarMN |
| WebUrl | String | 合同对比嵌入式web页面链接，有效期：5分钟 链接仅能使用一次 示例值：https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDtthUUckpx9l14eUy8nTBEypH6h1yKt&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF |
| RequestId | String | 唯一请求 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
}输出示例
{
"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"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.Db | 数据库异常。 |
| InvalidParameter | 参数错误。 |
