腾讯电子签集成版
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 腾讯电子签集成版 > API 文档 > 印章管理相关接口 > 创建印章授权

创建印章授权

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

我的收藏

本页目录：

1. 接口描述

接口请求域名： essbasic.tencentcloudapi.com 。

将指定印章授权给第三方平台子客企业下的某些员工

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ChannelCreateSealPolicy。
Version 是 String 公共参数，本接口取值：2021-05-26。
Region 否 String 公共参数，此参数为可选参数。
Agent 是 Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证。
SealId 是 String 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
UserIds.N 是 Array of String
员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
指定待授权的用户ID数组,电子签的用户ID
可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。

3. 输出参数

参数名称 类型 描述
UserIds Array of String 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
请求参数填写OpenId时，返回授权成功的 Openid。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建印章授权

给指定用户下发印章授权

输入示例

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "yDxAyUyK****cb7u0jQn0Zh7f7",
        "ProxyOperator": {
            "OpenId": "732aaef****541b89c49e0cc"
        },
        "AppId": "ed68bc6***********0214e4e"
    },
    "SealId": "yDRTZxxxxxJNR",
    "UserIds": [
        "yDdzlxxxxxopk"
    ]
}

输出示例

{
    "Response": {
        "UserIds": [
            "yDdzlxxxxxopk"
        ],
        "RequestId": "fdasfavdavxxxx"
    }
}

示例2 授权时，缺少印章ID

授权时，缺少印章ID

输入示例

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

{
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "SealId": "",
    "UserIds": [
        "abc"
    ],
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Organization": {
        "OrganizationId": "abc",
        "Channel": "abc",
        "OrganizationOpenId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter.ParamError",
            "Message": "缺失印章ID"
        },
        "RequestId": "abc"
    }
}

示例3 授权时，找不到对应的 UserId

授权时，找不到对应的 UserId

输入示例

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

{
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "SealId": "abc",
    "UserIds": [
        "abc",
        "xxxid"
    ],
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Organization": {
        "OrganizationId": "abc",
        "Channel": "abc",
        "OrganizationOpenId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter.ParamError",
            "Message": "无效的授权用户Id"
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.DependsDb 数据库异常。
InvalidParameter.ParamError 参数错误。
ResourceNotFound 资源不存在。
中国站


http://www.vxiaotou.com