按关键字签署合同

最近更新时间:2020-07-13 08:25:31

1. 接口描述

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

此接口适用于:客户平台在创建好合同后,由合同签署方对创建的合同内容进行确认,无误后再进行签署。客户平台使用该接口对PDF合同文档按照关键字和坐标进行签署。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SignContractByKeyword。
Version String 公共参数,本接口取值:2018-05-23。
Region String 公共参数,本接口不需要传递此参数。
Module String 模块名ContractMng
Operation String 操作名SignContractByKeyword
ContractResId String 合同ID
AccountResId String 账户ID
SignKeyword SignKeyword 签署关键字,偏移坐标原点为关键字中心
AuthorizationTime String 授权时间(由平台自动填充)
Position String 授权IP地址(由平台自动填充)
SealResId String 签章ID
CertType Integer 选用证书类型:1 表示RSA证书, 2 表示国密证书, 参数不传时默认为1
ImageData String 签名图片,base64编码

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按关键字签署合同

按关键字签署合同

输入示例

https://ds.tencentcloudapi.com/?Action=SignContractByKeyword
&Module=ContractMng
&Operation=SignContractByKeyword
&ContractResId=dcc-480rzey2gw
&AccountResId=dcu-c33uil3apq
&AuthorizationTime=20180531142255
&Position=10.0.0.238
&SealResId=dcs-c654e84rqw
&SignKeyword.Keyword=(甲方)
&SignKeyword.OffsetCoordX=0
&SignKeyword.OffsetCoordY=20
&SignKeyword.ImageHeight=150
&SignKeyword.ImageWidth=150
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "c2dfb7d4-4d3a-4e3b-81eb-516bc06c29e6"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AccountNotOwnContractError 该账号不具有该合同。
FailedOperation.AuthorizationTimeError 授权时间格式错误。
FailedOperation.CertTypeError 证书类型错误。
FailedOperation.ContractExpired 合同已过期。
FailedOperation.ContractSignedError 该合同已被签署过。
FailedOperation.CostAccountError 计费账户问题。
FailedOperation.DescribeSubplatError 获取子平台信息失败。
FailedOperation.FormatError 签署关键字信息中存在格式错误(偏移坐标,签章图片宽/高度都必须为数字)。
FailedOperation.IPFormatError 授权IP地址格式错误。
FailedOperation.ImageMeasurementOverLimitError 图片宽度/高度超过最大像素限制(300px)。
FailedOperation.NoPermissionToSign 用户没有开通代签权限。
FailedOperation.NoVerifyError 未经短信验证。
FailedOperation.OffsetCoordOverLimitError 偏移坐标超过最大偏移量,X轴/Y轴最大偏移量为50。
FailedOperation.Other 其它。
FailedOperation.SealMismatched 印章不匹配。
FailedOperation.SignContractByKeywordError 按关键字签署合同失败。
FailedOperation.SignFieldNotFound 根据关键字获得PDF签名域失败。
FailedOperation.UpdateFeeStatusError 更新计费状态错误。
FailedOperation.WrongCertType 证书类型为不支持的类型。
InternalError.UnknownError 内部错误。
MissingParameter.ImageMeasurementNullError 签署关键字信息-签章图片宽度/高度不能为空。
MissingParameter.KeywordNullError 签署关键字信息-关键字不能为空。
MissingParameter.MOError 找不到 module 或 operation。
MissingParameter.OffsetCoordNullError 签署关键字信息-偏移坐标不能为空。
ResourceNotFound.SubplatIdNotFound 子平台ID不存在。
ResourceUnavailable.SubplatUnavailable 子平台欠费。
目录