获取常规模块web页面
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateEmbedWebUrl。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
EmbedType | 是 | String | 要生成WEB嵌入界面的类型, 可以选择的值如下: - CREATE_SEAL: 生成创建印章的嵌入页面 - CREATE_TEMPLATE:生成创建模板的嵌入页面 - MODIFY_TEMPLATE:生成修改模板的嵌入页面 - PREVIEW_TEMPLATE:生成预览模板的嵌入页面 - PREVIEW_FLOW:生成预览合同文档的嵌入页面 - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面 - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面 - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面 - EXTEND_SERVICE:生成扩展服务的嵌入页面 |
BusinessId | 否 | String | WEB嵌入的业务资源ID - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId |
HiddenComponents | 否 | Boolean | 是否隐藏控件,只有预览模板时生效 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WebUrl | String | 嵌入的web链接 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 | 请升级到对应版本后即可使用该接口。 |