跳到主要内容

创建他方自动签授权链接

1. 接口描述

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

创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。

如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务

注:

  1. 所在企业的超管、法人才有权限调用此接口(Operator.UserId 需要传递超管或者法人的UserId)
  2. 已经在授权中或者授权成功的企业,无法重复授权
  3. 授权企业和被授权企业必须都是已认证企业
  4. 需要授权企业或被授权企业的超管或者法人打开链接走开通逻辑。

该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权 image

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreatePartnerAutoSignAuthUrl。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
AuthorizedOrganizationIdString被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入
AuthorizedOrganizationNameString被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
注: 如果名称中包含英文括号(),请使用中文括号()代替。
SealTypes.NArray of String在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:


  • OFFICIAL:企业公章,用于代表企业对外的正式文件和重要事务的认证。
  • CONTRACT:合同专用章,专门用于签署各类合同。
  • FINANCE:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。
  • PERSONNEL:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。

AuthToMeBoolean在处理授权关系时,授权的方向

  • false(默认值):表示我方授权他方。在这种情况下,AuthorizedOrganizationName 代表的是【被授权方】的企业名称,即接收授权的企业。
  • true:表示他方授权我方。在这种情况下,AuthorizedOrganizationName 代表的是【授权方】的企业名称,即提供授权的企业。

3. 输出参数

参数名称类型描述
UrlString授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
MiniAppPathString从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
ExpireTimeInteger链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建他方自动签授权链接-我方授权

创建他方自动签授权链接(AuthToMe设置成false)

输入示例

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

{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"AuthorizedOrganizationId": "yDRt2UUgygqxuvlqUuO4zjEySqVWqO9J",
"AuthToMe": false,
"SealTypes": [
"OFFICIAL"
]
}

输出示例

{
"Response": {
"ExpireTime": 1721984586,
"MiniAppPath": "/pages/guide/index?shortKey=yDCpEUNqf8CyuealGCfc",
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"Url": "https://essurl.cn/g4sjUBHlHx"
}
}

示例2 创建他方自动签授权链接-他方授权

他方授权给我方(AuthToMe被设置成true)

输入示例

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

{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"AuthorizedOrganizationName": "他方企业名称",
"AuthToMe": true,
"SealTypes": [
"OFFICIAL"
]
}

输出示例

{
"Response": {
"ExpireTime": 1721984586,
"MiniAppPath": "/pages/guide/index?shortKey=yDCpEUNqf8CyuealGCfc",
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"Url": "https://essurl.cn/g4sjUBHlHx"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
InvalidParameter参数错误。
MissingParameter缺少参数错误。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062