跳到主要内容

创建数据加签

1. 接口描述

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

创建数据加签请求

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateDigitalDataSign。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。使用此接口时,必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
AgentAgent代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
PlainTextString数据加签的原文
示例值:测试abc

3. 输出参数

参数名称类型描述
SignValueString加签签名值
示例值:MIAGCSqGSIb3DQEHAqCAMIACAQGSIb3DQEHATAcBgkqhkiG9w0B
SignTimestampString加签时间戳
示例值:MIIQHgYJKoZIhvNdoQ7niijSz8RtbRgul09Kcac9xiHwaU0SxCmU4pzu8IY0zL3Sk3qULParIU=
CertificateSignCertificate签署证书信息
SignAlgorithmString签署算法
示例值:RSA
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 输入原文进行签名

输入示例

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

{
"Operator": {
"UserId": "yDw**********************Rl77mox"
},
"PlainText": "测试abc"
}

输出示例

{
"Response": {
"Certificate": {
"CommonName": "ESS*******************782683",
"IssuerCommonName": "NMGSCA TEST RSA OCA1",
"NotAfter": 1800385201,
"NotBefore": 1768849201,
"SerialNumber": "220***********ab"
},
"SignAlgorithm": "RSA",
"SignTimestamp": "MIIQHgYJKoZIhvNdoQ7niijSz8RtbRgul09Kcac9xiHwaU0SxCmU4pzu8IY0zL3Sk3qULParIU=",
"SignValue": "MIAGCSqGSIb3DQEHAqCAMIACAQGSIb3DQEHATAcBgkqhkiG9w0B",
"RequestId": "fe8f8be8-b5b6-4ca1-bc04-979139f95ebc"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
MissingParameter缺少参数错误。
更多开发者交流反馈