数字作品存证接口

生产环境

POST

/v3/native/record/records

AVATA API 文档/AVATA API 文档/AVATA v3 API 文档/原生模块/区块链存证接口

您可将包括图片，视频，音频，文字、代码等作品文件数字化并在区块链上进行存证，让数字作品快速生成可溯源、可查验的可信化电子数据存证证明。
如果您是文昌链-天舟平台托管模式项目，可以使用该项目参数，通过该接口对某一类信息或文件在区块链上做存证，并且获得区块链存证证书。我们既支持单一存证主体，也支持多存证主体。
接口请求成功之后，可以通过上链交易结果查询接口 /v3/native/tx/{operation_id} 查询存证上链结果并获取区块链存证证书下载链接。
📢 注意：证书下载链接并非长期有效，请您尽快将证书文件下载至本地并妥善保管。

请求参数

Header 参数

Content-Type

string

必需

固定值：application/json

X-Api-Key

string

必需

项目 API Key，用于 API 访问鉴权

X-Timestamp

string

必需

时间戳，1970年1月1日0点0分0秒到现在的毫秒数

X-Signature

string

必需

API 签名，算法为SHA256(Params+Timestamp+ApiSecret)

Body 参数application/json

identity_type

enum<integer>

可选

存证主体；1:个人；2:企业

📢 传入多存证主体信息字段时，不支持此字段

枚举值:

identity_name

string

可选

个人姓名或企业名称，规范如下：
个人姓名：长度限制 1-16 个字符（UTF-8 编码），首字符不能是特殊符号；企业名称：长度限制 1-50 个字符（UTF-8 编码），首字符不能是特殊符号；

未传入存证主体字段时，不支持此字段；
传入存证主体字段时，此字段必填；
传入多存证主体信息字段时，不支持此字段；

identity_num

string

可选

个人为身份证号码，企业为统一社会信用代码；
未传入存证主体字段时，不支持此字段；
传入存证主体字段时，此字段选填；
传入多存证主体信息字段时，不支持此字段；

>= 18 字符<= 18 字符

identities

array [object {3}]

可选

📢 如果您拥有多个存证主体信息，可使用该字段。
传入此字段时，不支持单独传入 identity_type，identity_name，identity_num 字段；
存证证书中最多可展示两行存证主体信息，若想查看完整存证主体信息，可根据交易信息去对应的文昌链浏览器中查看完整信息。

>= 0 items<= 6 items

identity_type

integer

必需

存证主体；1:个人；2:企业

identity_name

string

必需

个人姓名或企业名称，规范如下：个人姓名：长度限制 1-16 个字符（UTF-8 编码），首字符不能是特殊符号；企业名称：长度限制 1-50 个字符（UTF-8 编码），首字符不能是特殊符号；

identity_num

string

可选

个人为身份证号码，企业为统一社会信用代码；未传入存证主体字段时，不支持此字段；传入存证主体字段时，此字段选填

type

enum<integer>

必需

作品类型:
1: 其它类型；
2: 文字作品；
3: 口述作品；
4: 音乐作品；
5: 戏剧作品；
6: 曲艺作品；
7: 舞蹈作品；
8: 杂技艺术作品；
9: 美术作品；
10: 建筑作品；
11: 摄影作品；
12: 视听作品；
13: 图形作品（工程设计图、产品设计图、地图、示意图等）；
14: 模型作品；

枚举值:

1234567891011121314

name

string

作品名称

必需

>= 1 字符<= 64 字符

description

string

作品描述

必需

>= 1 字符<= 512 字符

hash

string

必需

作品哈希；将单个作品源文件使用单向散列函数（如 MD5，SHA 等）进行一次 Hash 计算；将多个作品源文件分别进行一次 Hash 计算，再将得到的 Hash 值进行二次 Hash 计算

>= 1 字符<= 128 字符

hash_type

enum<integer>

必需

作品哈希类型 1:其它； 2:SHA256；3:MD5；4:SHA256-PFV；

枚举值:

1234

operation_id

string

必需

操作 ID，保证幂等性，避免重复请求，保证对于同一操作发起的一次请求或者多次请求的结果是一致的；由接入方生成的、针对每个 Project ID 唯一的、不超过 64 个大小写字母、数字、-、下划线的字符串

>= 1 字符<= 64 字符

正则匹配:

^[a-zA-Z0-9_-]+$

示例

{
  "identity_type": 1,
  "identity_name": "string",
  "identity_num": "stringstringstring",
  "identities": [
    {
      "identity_type": 0,
      "identity_name": "string",
      "identity_num": "string"
    }
  ],
  "type": 1,
  "name": "string",
  "description": "string",
  "hash": "string",
  "hash_type": 1,
  "operation_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.avata.bianjie.ai/v3/native/record/records' \
--header 'X-Api-Key;' \
--header 'X-Api-Key;' \
--header 'X-Timestamp;' \
--header 'X-Timestamp;' \
--header 'X-Signature;' \
--header 'X-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identity_type": 1,
    "identity_name": "string",
    "identity_num": "stringstringstring",
    "identities": [
        {
            "identity_type": 0,
            "identity_name": "string",
            "identity_num": "string"
        }
    ],
    "type": 1,
    "name": "string",
    "description": "string",
    "hash": "string",
    "hash_type": 1,
    "operation_id": "string"
}'

返回响应

🟢200successful operation

application/json

Body

data

object

正确返回值

必需

示例

{
  "data": {}
}

🟠400failed operation

修改于 2024-01-15 09:23:35

查询 MT 余额

查询上链交易结果