获取其他可嵌入web页面

1. 接口描述

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

本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：

1. 创建印章
2. 创建模板
3. 修改模板
4. 创建起草合同
5. 预览模板
6. 预览合同流程

预览模板的嵌入页面长相如下：

预览合同流程的嵌入页面长相如下：

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取合同详情嵌入WEB链接

获取合同详情嵌入WEB链接

输入示例

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

{
    "Operator": {
        "UserId": "yDwJsUUckpkjss52UCW2se8TOSLS4tEP"
    },
    "BusinessId": "aDRt2UUgygqxyp9yUuO4zjEwqXwsIljY",
    "EmbedType": "PREVIEW_FLOW_DETAIL"
}

输出示例

{
    "Response": {
        "WebUrl": "https://embed.test.qian.tencent.cn//contract-details?embed=1&code=yDwFJUUckpsm2e3xU6LVMFEMw1e4YIkb&channel=TENCENTCLOUD&businessId=yDwFFUUckps75s4pUEmvMvC8iyRPYukZ&businessType=DOCUMENT&scene=SINGLEPAGE",
        "RequestId": "s1694572778289857146"
    }
}

示例2 获取生成印章嵌入WEB链接

获取生成印章嵌入WEB链接

输入示例

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

{
    "Operator": {
        "UserId": "yDwJsUUckpkjss52UCW2se8TOSLS4tEP"
    },
    "EmbedType": "CREATE_SEAL",
    "Agent": {
        "ProxyOrganizationId": ""
    }
}

输出示例

{
    "Response": {
        "WebUrl": "https://embed.qian.tencent.cn/seal-create?embed=1&code=yDwgzUUckp12yp52UEHWYmLCd041eukw&channel=TENCENTCLOUD&businessType=SEAL",
        "RequestId": "s1694572778289857145"
    }
}

示例3 获取合同详情嵌入WEB链接-指定可查看控件

获取合同详情嵌入WEB链接-指定可查看控件

输入示例

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

{
    "Operator": {
        "UserId": "yDwJsUUckpkjss52UCW2se8TOSLS4tEP"
    },
    "BusinessId": "aDRt2UUgygqxyp9yUuO4zjEwqXwsIljY",
    "EmbedType": "PREVIEW_FLOW_DETAIL",
    "Option": {
        "ShowFlowDetailComponent": true
    }
}

输出示例

{
    "Response": {
        "WebUrl": "https://embed.test.qian.tencent.cn//contract-details?embed=1&code=yDwFJUUckpsm2e3xU6LVMFEMw1e4YIkb&channel=TENCENTCLOUD&businessId=yDwFFUUckps75s4pUEmvMvC8iyRPYukZ&showComponent=1&businessType=DOCUMENT&scene=SINGLEPAGE",
        "RequestId": "s1694572778289857146"
    }
}

示例4 获取合同详情嵌入Web链接失败，是因为对应的签署流程不存在。

获取合同详情嵌入Web链接失败，是因为对应的签署流程不存在。

输入示例

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

{
    "Operator": {
        "UserId": "yDwJsUUckpkjss52UCW2se8TOSLS4tEP"
    },
    "BusinessId": "aDRt2UUgygqxyp9yUuO4zjEwqXwsIljY",
    "EmbedType": "PREVIEW_FLOW_DETAIL"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InternalError.DataNotFound",
            "Message": "未查询到流程"
        },
        "RequestId": "s1694572778289857144"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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