跳到主要内容

获取常规模块嵌入页面链接

1. 接口描述

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

本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接

本接口下面功能的签署页面链接的生成

  • 创建印章
  • 创建模板
  • 修改模板
  • 预览模板
  • 预览合同流程

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelCreateEmbedWebUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
EmbedTypeString要生成WEB嵌入界面的类型, 可以选择的值如下:


  • CREATE_SEAL: 生成创建印章的嵌入页面
  • CREATE_TEMPLATE:生成创建模板的嵌入页面
  • MODIFY_TEMPLATE:生成修改模板的嵌入页面
  • PREVIEW_TEMPLATE:生成预览模板的嵌入页面
  • PREVIEW_FLOW:生成预览合同文档的嵌入页面(支持移动端)
  • PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面(仅支持PC端)
  • PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
  • PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
  • EXTEND_SERVICE:生成扩展服务的嵌入页面


示例值:MODIFY_TEMPLATE
BusinessIdStringWEB嵌入的业务资源ID


  • 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
  • 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
  • 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId


示例值:yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc
HiddenComponentsBoolean是否隐藏控件,只有预览模板时生效
示例值:false
UserDataString用户自定义参数

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

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

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




示例值:eyJDb21lRnJvbSI6Inh4eCJ9
OptionEmbedUrlOption个性化参数,用于控制页面展示内容

3. 输出参数

参数名称类型描述
WebUrlString嵌入的web链接,5分钟有效
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取创建印章的嵌入WEB链接

获取创建印章的嵌入WEB链接

输入示例

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

{
"BusinessId": "",
"EmbedType": "CREATE_SEAL",
"Agent": {
"AppId": "yDxjb***********8n",
"ProxyOrganizationOpenId": "testOpenId",
"ProxyOperator": {
"OpenId": "testOpenId"
}
}
}

输出示例

{
"Response": {
"WebUrl": "https://test.ess.com/seal-create?embed=1&code=testcode&channel=PROXYCHANNEL",
"RequestId": "2"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
FailedOperation.NoRoleAuth无角色授权,请确认数据是否存在
InternalError.DbRead数据库读取失败。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Flow未找到对应流程。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062