1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
获取他方企业第三方应用的创建及授权及企业用户初始化链接
此链接在 7 天内有效,若失效请重新生成。
若第一次初始化,打开此链接,会进行应用号的创建,子客的创建,打开此链接的人,必须是合作方企业的超管或者法人,否则无法认证成功。
若传递了应用号Id,若之前的初始化还未创建子客成功,则可以继续创建子客企业。
注:
- BusinessId “集成方业务标记”唯一,不可变更, 此标记由电子签产品经理提供,请调用方保存。
- 若“第三方应用id”不为空,需要其“集成方业务标记”与接口一致。
- 不支持客户自己创建“已有第三方应用id”进行授权。(即“已有第三方应用id”的集成方业务标记为空,不能进行授权)。
- 创建的子客企业与合作企业一致,其中包括超管姓名,企业名称。
- 创建好的第三方应用号,不支持在页面进行修改编辑,只能通过接口的方式进行管理。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreatePartnerAuthorizationLink。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
| BusinessId | 是 | String | 腾讯电子签平台给生态集成方分配的生态集成业务标识, 此生态集成业务标识需要提前联系产品经理配置。 示例值:jdyxk |
| PartnerOrganizationId | 是 | String | 合作方企业在腾讯电子签注册企业后生成的企业id,需要合作方企业登录 电子签控制台获取 ![]() 示例值:yDxjsUUgdj335****4zjEvfko0F1BB |
| ApplicationInfo | 是 | CallbackInfo | 第三方应用的配置信息。 其中包括 回调地址,加密KEY等信息。 |
| ProxyOrganizationInfo | 是 | ProxyOrganizationInfo | 第三方应用下企业用户信息。 其中包括企业的OrganizationOpenId和超管的UserOpenId。 具体含义请参考结构体解释 |
| PartnerApplicationId | 否 | String | 若未填写,则会创建一个生态集成应用。 若填写, 则必须是生态集成企业给合作方企业通过此接口CreatePartnerAuthorizationLink创建的应用号。 应用号可以从下图位置获取。 ![]() 示例值:yD3nhUUck*upU***IGBN50TJsNwY |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Link | String | 授权链接,以短链形式返回。短链的有效期参考回参中的 ExpiredTime。 注: 1. 非小程序和APP集成使用 2. 生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误) 示例值:https://test.qian.tencent.cn/console/third-app-auth?token=yD3aIUUckpmou8niUxFA3TWyp6dwJwKA |
| ExpireTime | Integer | 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。 示例值:1773400421 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建应用并且授权子客企业链接
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePartnerAuthorizationLink
<公共请求参数>
{
"Operator": {
"UserId": "yDwf3UUckps**v**UEfH3DjwIpMfa0uw"
},
"BusinessId": "jdyxk",
"PartnerOrganizationId": "yDxjsUUg*dj*335****4zjEvfko0F1BB",
"ApplicationInfo": {
"CallbackUrl": "https://v.qq.com",
"CallbackKey": "yDwf3U**kp*8*v********jwIpMfa0uw"
},
"ProxyOrganizationInfo": {
"OrganizationOpenId": "ererer",
"OperatorOpenId": "2323"
},
"PartnerApplicationId": "yD3nhUUck***up**U***IGBN50TJsNwY"
}
输出示例
{
"Response": {
"ExpireTime": 1773400421,
"Link": "https://test.qian.tencent.cn/console/third-app-auth?token=yD3aIUUckpmou8niUxFA3TWyp6dwJwKA",
"RequestId": "a486dde2-d36a-425f-911b-802e0d36a362"
}
}
示例2 已有授权应用,创建子客企业授权链接
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePartnerAuthorizationLink
<公共请求参数>
{
"Operator": {
"UserId": "yDwf3U*c**s8*v*********wIpMfa0uw"
},
"BusinessId": "jdyxk",
"PartnerOrganizationId": "yDxjsUU***j*3***U****jE*fko0F1BB",
"ApplicationInfo": {
"CallbackUrl": "https://v.qq.com",
"CallbackKey": "yD3nhUUc***eu**p*******N50TJsNwY"
},
"ProxyOrganizationInfo": {
"OrganizationOpenId": "org_open_id",
"OperatorOpenId": "operator_open_id"
},
"PartnerApplicationId": "yD3nhU**kp**********IGBN50TJsNwY"
}
输出示例
{
"Response": {
"ExpireTime": 1773400245,
"Link": "https://test.qian.tencent.cn/console/third-app-auth?token=yD3aIUUckpmouq0qUxnX3yhReAfE4eqs",
"RequestId": "cb3df742-c9f7-4938-9574-4e2893d9ee8f"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |

