获取其他可嵌入web页面
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：
- 创建印章
- 创建模板
- 修改模板
- 预览模板
- 预览合同流程
预览模板的嵌入页面长相如下：
预览合同流程的嵌入页面长相如下：
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEmbedWebUrl。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| EmbedType | 是 | String | WEB嵌入资源类型，支持以下类型
|
| BusinessId | 否 | String | WEB嵌入的业务资源ID 当EmbedType取值
注意： 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口创建文件转换任务 和查询转换任务状态 来进行转换成PDF资源。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| Reviewer | 否 | ReviewerInfo | 抄送方信息 |
| Option | 否 | EmbedUrlOption | 个性化参数，用于控制页面展示内容 |
| UserData | 否 | String |
示例值：eyJDb21lRnJvbSI6IuadpeiHqnh4eOWFrOWPuOeahOaooeeJiCJ9 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| WebUrl | String | 嵌入的web链接，有效期：5分钟 EmbedType=PREVIEW_CC_FLOW，该url为h5链接 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
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.DataNotFlound",
"Message": "未查询到流程"
},
"RequestId": "s1694572778289857144"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.Forbid | 禁止此项操作。 |
| OperationDenied.WhiteListForbid | 未开通功能白名单，请联系客服处理。 |
| ResourceNotFound.Flow | 签署流程未找到，请检查参数。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |