跳到主要内容

获取其他可嵌入web页面

1. 接口描述

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

本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:

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

用户可以通过这些链接快速将其集成到自己的系统中。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateEmbedWebUrl。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。

注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
EmbedTypeStringWEB嵌入资源类型,支持以下类型
  • CREATE_SEAL: 生成创建印章的嵌入页面
  • CREATE_TEMPLATE:生成创建模板的嵌入页面
  • MODIFY_TEMPLATE:生成编辑模板的嵌入页面
  • PREVIEW_TEMPLATE:生成预览模板的嵌入页面
  • PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
  • PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
  • EXTEND_SERVICE:生成拓展服务的嵌入页面
  • PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)
  • PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)
BusinessIdStringWEB嵌入的业务资源ID
  • PREVIEW_SEAL_DETAIL,必填,取值为印章id
  • MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
  • PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id

AgentAgent代理企业和员工的信息。

在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
ReviewerReviewerInfo抄送方信息
OptionEmbedUrlOption个性化参数,用于控制页面展示内容
UserDataString用户自定义参数

  • 目前仅支持EmbedType=CREATE_TEMPLATE时传入
  • 指定后,创建,编辑,删除模板时,回调都会携带该userData
  • 支持的格式:json字符串的BASE64编码字符串
  • 示例:

    • json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9

    • eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式




示例值:eyJDb21lRnJvbSI6IuadpeiHqnh4eOWFrOWPuOeahOaooeeJiCJ9

3. 输出参数

参数名称类型描述
WebUrlString嵌入的web链接,有效期:5分钟

EmbedType=PREVIEW_CC_FLOW,该url为h5链接
RequestIdString唯一请求 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请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062