创建企业自动签授权链接
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。
如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务
注:
- 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
- 已经在授权中或者授权成功的企业，无法重复授权
- 授权企业和被授权企业必须都是已认证企业
- 需要授权企业或被授权企业的超管或者法人打开链接走开通逻辑。
该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreatePartnerAutoSignAuthUrl。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
| AuthorizedOrganizationId | 否 | String | 被授企业id/授权方企业id（即OrganizationId），如果是企业之间授权和AuthorizedOrganizationName二选一传入。 注： 被授权企业必须和当前企业在同一应用号下 |
| AuthorizedOrganizationName | 否 | String | 被授企业名称/授权方企业的名字，如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。 注: 1. 如果名称中包含英文括号()，请使用中文括号（）代替。 2. 被授权企业必须和当前企业在同一应用号下 |
| PlatformAppAuthorization | 否 | Boolean | 是否给平台应用授权
注：授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单，请联系运营经理开通。 |
| SealTypes.N | 否 | Array of String | 在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括：
|
| AuthToMe | 否 | Boolean | 在处理授权关系时，授权的方向
|
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Url | String | 授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。 注意：此字段可能返回 null，表示取不到有效值。 |
| MiniAppPath | String | 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径 |
| ExpireTime | Integer | 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 授权给渠道平台应用
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePartnerAutoSignAuthUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"PlatformAppAuthorization": true
}
输出示例
{
"Response": {
"ExpireTime": 1702982931,
"MiniAppPath": "/pages/guide/index?shortKey=002XCUHfPi ",
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"Url": "https://essurl.cn/003hGUFil8 "
}
}
示例2 我方授权他方
授权给张三示例企业能发完我方的自动签署的合同
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePartnerAutoSignAuthUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"AuthorizedOrganizationName": "张三示例企业",
"SealTypes": [
"OFFICIAL"
]
}
输出示例
{
"Response": {
"ExpireTime": 1702982931,
"MiniAppPath": "/pages/guide/index?shortKey=002XCUHfPi ",
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"Url": "https://essurl.cn/003hGUFil8 "
}
}
示例3 他方授权我方
让王五示例企业授权给我方能发起他们的自动签署合同
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePartnerAutoSignAuthUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"AuthorizedOrganizationName": "王五示例企业",
"AuthToMe": true,
"SealTypes": [
"OFFICIAL"
]
}
输出示例
{
"Response": {
"ExpireTime": 1702982931,
"MiniAppPath": "/pages/guide/index?shortKey=002XCUHfPi ",
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"Url": "https://essurl.cn/003hGUFil8 "
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.Application | 应用号不存在。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |