有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

用户通过本接口向BTOE写入待存证的文档原文件或下载URL,BTOE对文档原文件存储后,将其Hash值存证上链,并生成含有电子签章的区块链存证电子凭证。文档类型支持格式:doc、docx、xls、xlsx、ppt、pptx、 pdf、html、txt、md、csv;原文件上传大小不超过5 MB,下载URL文件大小不超过10 MB。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDocDeposit。
Version String 公共参数,本接口取值:2021-05-14。
Region String 公共参数,详见产品支持的 地域列表
EvidenceName String 存证名称(长度最大30)
FileContent String 数据Base64编码,大小不超过5M
FileName String 带后缀的文件名称,如 test.doc
EvidenceHash String 文件hash
BusinessId String 业务ID 透传 长度最大不超过64
HashType Integer 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
示例值:0,1,2
EvidenceDescription String 存证描述

3. 输出参数

参数名称 类型 描述
BusinessId String 业务ID 透传 长度最大不超过64
注意:此字段可能返回 null,表示取不到有效值。
EvidenceId String 请求成功,返回存证编码,用于查询存证后续业务数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文档存证

用户通过本接口向BTOE写入待存证的文档原文件或下载URL,BTOE对文档原文件存储后,将其Hash值存证上链。

输入示例

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

{
    "BusinessId": "as1111323311",
    "EvidenceName": "存证名称",
    "FileContent": "",
    "FileName": "",
    "EvidenceHash": "",
    "HashType": 0,
    "EvidenceDescription": "存证描述"
}

输出示例

{
    "Response": {
        "EvidenceId": "eac6b301-a322-493a-8e36-83b295459397",
        "BusinessId": "as1111323311",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.FileEncodindFormatError 文件编码格式错误。
FailedOperation.FileReadFailed 文件读取失败。
FailedOperation.UnKnowError 未知错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidFileSuffix 文件后缀不正确。
InvalidParameter.InvalidParameterValue 参数值错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.HashNoMatch 哈希不匹配。
InvalidParameterValue.InvalidFileSuffix 文件后缀不正确。
InvalidParameterValue.InvalidURL URL无效。
InvalidParameterValue.TooLargeFileError 文件内容太大。
ResourceInsufficient.LowBalance 余额不足。
ResourceNotFound.DownLoadError 文件下载失败。
ResourceUnavailable.ResourceNotOpened 资源未完成开通。


http://www.vxiaotou.com