腾讯电子签文件加签接口

1. 接口描述

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

此接口用于发起数字文件CA加签操作。可以使用同步或者异步模式进行。

注意： 1. 文件类型暂时仅支持PDF类型文件。2. 此接口为『数字文件CA加签服务』白名单功能，使用前请联系对接的客户经理沟通。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFileCounterSign。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
FileId	是	String	需要加签的文件Id。注: `暂时只支持pdf类型的文件` 示例值：yDtwRUUckp7f7e****qq28pI
Operator	否	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
SyncMode	否	Boolean	是否使用同步模式。 false:异步模式，返回taskId。需要使用taskId轮询结果查询接口。 true: 同步模式，此接口将直接返回taskId和ResultFileId(加签后文件id)。注： 1. 当加签文件较大的时候，建议使用异步接口进行操作。否则文件加签时间过长会导致接口超时。示例值：false

3. 输出参数

参数名称	类型	描述
Status	String	加签任务的状态。 PROCESSING: 任务正在执行中。 FINISHED: 已执行成功示例值：PROCESSING
ResultFileId	String	加签完成后新的文件Id 示例值：yDtwRUUckp7f7e****qq28pI
TaskId	String	异步模式下用于轮询状态的任务Id 示例值：yDCmrUUc****6
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文件CA加签--同步模式

文件CA加签--同步模式

输入示例

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

{
    "Operator": {
        "UserId": "yDCpyUc*******************bsVny9l"
    },
    "SyncMode": true,
    "FileId": "yDtwuU*******************FYPZ"
}

输出示例

{
    "Response": {
        "RequestId": "xxxxxxxxxxx",
        "ResultFileId": "yD45ww**********************ZIM1o",
        "Status": "FINISHED",
        "TaskId": "yDsdsU********************EtgCQI7"
    }
}

示例2 文件CA加签--异步模式

文件CA加签--异步模式

输入示例

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

{
    "Operator": {
        "UserId": "yDCpyUc*******************bsVny9l"
    },
    "SyncMode": true,
    "FileId": "yDtwuU*******************FYPZ"
}

输出示例

{
    "Response": {
        "RequestId": "谢谢谢谢谢谢休息休息",
        "ResultFileId": "",
        "Status": "FINISHED",
        "TaskId": "yDtww************************EtgCQI7"
    }
}

示例3 文件CA加签--同步模式--主带子场景

文件CA加签，使用同步模式，且集团主企业使用子企业CA进行加签场景

输入示例

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

{
    "Operator": {
        "UserId": "yDCpyUc*******************bsVny9l"
    },
    "Agent": {
        "ProxyOrganizationId": "yUIdyeU*******************bsdf234l"
    },
    "SyncMode": true,
    "FileId": "yDtwuU*******************FYPZ"
}

输出示例

{
    "Response": {
        "RequestId": "xxxxxxxxxxx",
        "ResultFileId": "yD45ww**********************ZIM1o",
        "Status": "FINISHED",
        "TaskId": "yDsdsU********************EtgCQI7"
    }
}

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	操作失败。
FailedOperation.BalanceNotEnough	套餐余额不足。
InternalError	内部错误。
InternalError.Api	第三方接口失败。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ErrNoResourceAccess	此企业无该资源使用权限。
ResourceNotFound	资源不存在。

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

批量计算

API 网关

专线接入

微服务平台 TSF

对象存储

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

弹性网卡

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

网络流日志

内容分发网络 CDN

云数据库 Redis®

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

腾讯云可观测平台

云拨测

腾讯云区块链服务平台 TBaaS

主机安全

访问管理

DDoS 防护

标签

密钥管理系统

Web 应用防火墙

域名注册

操作审计

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

口语评测（基础版）

人脸识别

文字识别

图像识别

集团账号管理

Elasticsearch Service

媒体处理

云直播

云联络中心

物联网通信

机器翻译

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

腾讯云数据仓库 TCHouse-C

数据安全治理中心

Cloud Studio（云端 IDE）

实时互动-教育版

设备安全

智能视图计算平台

云数据库 KeeWiDB

声音复刻

商场客留大数据