获取签署存证证书查看二维码

1. 接口描述

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

获取区块链存证证书查看链接/二维码接口

适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。

点击查看区块链存证证书样式

注：

1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为7天，超过有效期则不可用。
2. 合同状态需为签署完成、已解除才能生成证书查看二维码/短链。
3. 调用接口时，需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。
4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证证书，请妥善保管好二维码或链接。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFlowBlockchainEvidenceUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
FlowId	是	String	合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
ExpiredOn	否	Integer	链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。默认值为有效期为当前时间后7天。

3. 输出参数

参数名称	类型	描述
QrCode	String	二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。示例值：https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d7914ff197f4b2b099ab565a5733
Url	String	查看短链，可直接点击短链查看证书。示例值：https://test.essurl.cn/SR04UBxxxx
ExpiredOn	Integer	二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成合同区块链存证证书查看二维码/链接

拥有访问权限的员工生成合同区块链存证证书查看二维码/链接

输入示例

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

{
    "Operator": {
        "UserId": "yDR0fUUgyg*********jE1RTDui4pB"
    },
    "FlowId": "yDCANUUc************SI8fHrn0LCd"
}

输出示例

{
    "Response": {
        "ExpiredOn": 1719463451,
        "QrCode": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d7914ff197f4b2b0*********27ec738d02a519c7a9f",
        "RequestId": "s1718858684971",
        "Url": "https://test.essurl.cn/SR0*****HF9B"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	第三方接口失败。
InternalError.Db	数据库异常。
InternalError.Decryption	解密失败。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceUnavailable	资源不可用。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 生成合同区块链存证证书查看二维码/链接​

输入示例​

输出示例​

5. 错误码​