创建他方企业自动签授权链接

最近更新时间：2024-04-03 11:19:18

我的收藏

本页目录：

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 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
AuthorizedOrganizationId	否	String	被授企业id，和AuthorizedOrganizationName二选一，不能同时为空注：`被授权企业必须和当前企业在同一应用号下`
AuthorizedOrganizationName	否	String	被授权企业名，和AuthorizedOrganizationId二选一，不能同时为空注：`被授权企业必须和当前企业在同一应用号下`
PlatformAppAuthorization	否	Boolean	是否给平台应用授权: - true: 是（无需设置AuthorizedOrganizationId和AuthorizedOrganizationName） - false: 否（默认）注：该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”，请联系运营经理开通

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": "yDSxxxxxxxxxOnHtH51",
        "ProxyOrganizationOpenId": "org_open_id",
        "ProxyOperator": {
            "OpenId": "user_open_id"
        }
    },
    "AuthorizedOrganizationId": "org_open_id_another",
    "AuthorizedOrganizationName": "典子谦子客企业",
    "PlatformAppAuthorization": true
}

输出示例

{
    "Response": {
        "ExpireTime": 1702982931,
        "MiniAppPath": "/pages/guide/index?shortKey=yDSxxxxxxxxxOnHtH51",
        "RequestId": "s1702378131281988373",
        "Url": "https://test.essurl.cn/WxxxxxwH"
    }
}

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

输入示例

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

{
    "Agent": {
        "AppId": "yDSxxxxxxxxxOnHtH51",
        "ProxyOrganizationOpenId": "org_open_id",
        "ProxyOperator": {
            "OpenId": "user_open_id"
        }
    },
    "AuthorizedOrganizationId": "org_open_id_another",
    "AuthorizedOrganizationName": "典子谦子客企业"
}

输出示例

{
    "Response": {
        "ExpireTime": 1702982931,
        "MiniAppPath": "/pages/guide/index?shortKey=yDSxxxxxxxxxOnHtH51",
        "RequestId": "s1702378131281988373",
        "Url": "https://test.essurl.cn/WxxxxxwH"
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ParamError	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound.Application	应用号不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

下一篇: 更新历史