获取常规模块嵌入页面链接
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
- 创建印章
- 创建模板
- 修改模板
- 预览模板
- 预览合同流程
预览模板的嵌入页面长相如下:
预览合同流程的嵌入页面长相如下:
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateEmbedWebUrl。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
EmbedType | 是 | String | 要生成WEB嵌入界面的类型, 可以选择的值如下:
示例值:MODIFY_TEMPLATE |
BusinessId | 否 | String | WEB嵌入的业务资源ID
示例值:yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc |
HiddenComponents | 否 | Boolean | 是否隐藏控件,只有预览模板时生效 示例值:false |
UserData | 否 | String | 用户自定义参数
示例值:eyJDb21lRnJvbSI6Inh4eCJ9 |
Option | 否 | EmbedUrlOption | 个性化参数,用于控制页面展示内容 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WebUrl | String | 嵌入的web链接,5分钟有效 |
RequestId | String | 唯一请求 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 | 请升级到对应版本后即可使用该接口。 |