当前接口文档对应合约版本:V1.4 20220308

本文档内容归四川省区块链协会所有,仅提供于合作伙伴,未经许可不得外传!

一、接入步骤

  1. 引入sdk jar包

2)实例化blockService

2.1 传入appkey和appsecet

blockService = new BlockService(appKey, appSecret);

2.2 通用灵活配置的方式

根据创建的链的相关配置信息创建LunaProperties实例对象,示例如下:

LunaProperties lunaProperties = new LunaProperties();
**lunaProperties.setUrl("“);
lunaProperties.setAppKey(”“);
lunaProperties.setAppSecret(”“);**
lunaProperties.setChainCodeName(”xblcode-scbsi“);
lunaProperties.setChannelName(”xblchain-scbsi");
lunaProperties.setVersion(LunaProperties.Version.LUNA_2);

url、Org、appkey、secret四个参数是在添加应用后,即可在应用授权中获取到的接入地址、key及secret;

  1. 创建并初始化SdkService实例对象,示例如下:

SdkService sdkService = new SdkService(lunaProperties);

  1. 使用sdkService调用接口

二、实体定义

2.1用户

对用户信息(公钥绑定)上链存证的实体定义

参数 类型 备注
Uid string 用户id
Pk string 用户公钥
appkey 应用授权标识

2.2版权

对传统版权信息上链存证的实体定义

参数 类型 备注
Key string 版权存证号。由SDK生成,规则为bsicop+当前时间戳+4位随机数
WorkName string 作品名称
WorkDataFinger string 作品数据指纹
WorkCategory int 作品类别(详见作品类别枚举)
WorkCreateType int 作品创作性质(详见作品创作性质枚举)
RightObtainType int 权利取得方式(详见权利取得方式枚举)
RightHaveType int 权利拥有方式(详见权利拥有方式枚举)
AuthorType int 著作权人类型(详见著作权人类型枚举)
AuthorName string 著作权人名称
AuthorCertificateNo string 证件号,身份证号或企业信用代码
WorkCompletionTime datetime 作品完成时间
WorkUrl string 作品存储地址及提取码
RegisterStatus string 版权局登记状态(详见版权局登记状态枚举)
RegistrationCopyrightOffice string 登记版权局
Status int 链上存证有效状态(详见链上存证有效状态枚举)
ExtendField string 扩展信息、预留字段
appkey string 应用授权标识

2.3通用存证

对其他存证业务需求上链的实体定义,分为侵权检测任务、侵权证据及其他三个类别

参数 类型 备注
Key String 存证业务主键,由SDK生成,规则为bsievi+当前时间戳+4位随机数
EviName String 证据标题
EvidenceType String 存证类型(1-侵权检测任务、2-侵权证据、0-其他)
Val String 存证数据值
DataFinger String 数据指纹,数据指纹,用户可自行录入,或以sdk提供的方法计算
ExtendField String 扩展信息
Version String 版本号
AppId String 应用Id
Uid String 存证用户Id
appkey string 应用授权标识

2.4NFT发行计划

针对NFT发行计划的链上存证实体

参数 类型 备注
Key String 资产元数据,即metadata,由用户传入,一般为版权key
Name String 资产名称
Symbol String 资产符号
Property String 资产属性,创建方自行定义
totle int 发行总量,如 10000
ReleaseTotal int 已发行量,仅此字段可修改(合约内部)
uid String 发行方也为用户id
ExtendField String 扩展信息
appkey string 应用授权标识

2.5NFT资产

针对非同质化资产的链上实体定义

参数 类型 备注
Key String NFT资产编号,由SDK生成,规则为bsinft+当前时间戳+四位随机数
Name String 资产名称
Symbol String 资产符号
MetaData String 资产元数据(链上版权编号、发行计划Key)
totle int 发行总量,如 10000
sn int 发行序号(1-10000),如 23
Status int 资产状态(1-正常、2-冻结、0-销毁)
Property String 资产属性,创建方自行定义
OldAssetProportions String 原资产所有人
AssetProportions String 资产所有人(自定义结构数组,包含资产接收方pk与所占份额,总份额必须为100%。)
ExtendField String 扩展信息
appkey string 应用授权标识
finalPrice string 成交价
Price string 发行价

2.6侵权监测任务

针对侵权检测任务的链上实体定义

略

三、用户公钥绑定

​ 每个用户公钥只需绑定一次,用户可以根据sdk内sm2方法生成,并应自行妥善保管私钥。

Title: 用户公钥绑定
应用系统->SDK:用户公钥绑定(Uid、Pk、Sk)
SDK->SDK:签名组装
SDK->链: 用户公钥绑定(Uid、Pk、appkey、sign)
链->链:验证UiD未绑定过Pk,上链
链->SDK:返回上链结果信息
SDK->应用系统:返回上链结果信息

(1)SDK接口

  1. 函数名称:userRegister

  2. 请求参数:UidDTO

参数名称 参数类型 最大长度 是否必要 参数说明
Uid String Y 用户Id
Pk String Y 用户公钥
Sk String Y 用户私钥
  1. 响应参数:SdkResponse
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTO 返回数据

​ ChainResDTO说明:

参数名称 参数类型 备注
transactionId String 交易hash(异常时必备)
previousHash String 前一区块hash
dataHash String 区块哈希
time String 记链时间
timestamp Date 记链时间戳
height Long 区块高度
  1. 异常说明:
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

4)示例代码

UidDTO uidDTO = new UidDTO();
uidDTO.setUid(uid);
uidDTO.setSk(sk);
uidDTO.setPk(pk);
ChainResDTO resDTO = blockService.userRegister(uidDTO);

(2)智能合约设计

略

三、版权合约及SDK设计

3.1 传统版权数字化

3.1.1链上版权登记

​ 版权应用平台通过调用此版权链上登记接口,实现版权存证固证、链上数字化。

此处调用流程为:

业务系统->SDK:版权登记入参
SDK->SDK:校验非空字段
SDK->SDK: 判断是否有文件
SDK-->文件存储服务: 若存在文件,计算文件指纹(MD5),作品原文存储
文件存储服务-->SDK: 存储地址Url
SDK->SDK:生成主键key、签名
SDK->链: 版权上链信息、签名
链->链: uid、sign判空
链->链: 根据uid查询公钥,如果不存在,则存证失败。
链->链: 验签
链->链: key判重处理,如果key存在,则存证失败。
链-->链: 数据指纹判重处理,已存在,则存证失败。
链->链: key为主键版权信息上链。
链-->链: 数据指纹上链。
链->SDK:返回上链结果信息
SDK->业务系统:上链返回key及区块信息

(1)SDK接口

接口方法:copyrightAdd

参数 类型 最大长度 必填项 备注
workName string 128 Y 作品名称
workCategory string Y 作品类别(详见作品类别枚举)
workCreateType string Y 作品创作性质(详见作品创作性质枚举)
rightObtainType string Y 权利取得方式(详见权利取得方式枚举)
rightHaveType string Y 权利拥有方式(详见权利拥有方式枚举)
authorType string Y 作者类型(详见作者类型枚举)
authorName string 128 Y 作者名称
authorCertificateNo string 128 Y 作者证件号
workCompletionTime long Y 作品完成时间
work string N 作品文件
workCategory string N 作品数据指纹(有传入作品文件时,此项不需要填写,SDK自动提取MD5值覆盖该值。无作品时,此项必填 )
registerStatus string Y 版权局登记状态(详见版权局登记状态枚举)
registrationCopyrightOffice string 128 Y 登记版权局(未登记则填入:未登记)
extendField string 512 N 扩展信息、预留字段
Uid string Y 应用uid
sk string Y 私钥
参数 类型 是否必备 备注
status int Y 状态码(详见状态码定义)
msg string Y 提示信息
key string Y 链上版权ID
data ChainResDTO N 返回数据(见ChinaResDTO说明)
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

log.info("新增版权:=======================");
CopyrightDTO dto = new CopyrightDTO();
setBaseParam(dto);
dto.setExtendField("222");
dto.setWorkName("那人那山那狗");
dto.setWorkCategory(CopyrightDTO.WorkCategory.WC1);
dto.setWorkCreateType(CopyrightDTO.WorkCreateType.WCT0);
dto.setRightObtainType(CopyrightDTO.RightObtainType.ROT0);
dto.setRightHaveType(CopyrightDTO.RightHaveType.RHT0);
dto.setAuthorType(CopyrightDTO.AuthorType.AT1);
dto.setAuthorName("小张");
dto.setAuthorCertificateNo("2222233");
dto.setWorkCompletionTime(System.currentTimeMillis());
dto.setRegisterStatus(CopyrightDTO.RegisterStatus.RS3);
dto.setRegistrationCopyrightOffice("神州出版社");
ChainResDTO resDTO = blockService.copyrightAdd(dto);
String key = resDTO.getKey();
log.info("新增版权成功:key=[{}],返回区块信息=[{}]", key, resDTO);

(2)智能合约协议

略

3.1.2版权更新

版权原登记平台通过调用此版权更新接口,实现对已在链上登记版权的更新记录。

原文无更新的,不需要上传文件。

业务系统->SDK:版权更新信息入参
SDK->SDK:非空字段校验,key、uid、appid、sk不为空
SDK-->SDK:计算文件指纹
SDK-->文件存储:原文上传文件服务
文件存储-->SDK:文件url
SDK->链: 版权上链信息、签名
链->链: 非空字段校验
链->链: 获取uid公钥,不存在则更新失败
链->链: 验签
链-->链: 文件指纹判重,若存在且不等于当前key则存证失败
链->链: 获取链上的其他非空字段信息赋值给当前更新对象
链->链: 链上更新版权信息
链->SDK:返回上链结果信息
SDK->业务系统:上链结果

(1)SDK接口

接口名称:copyrightUpdate()

参数 类型 长度 必填项 备注
key string Y 版权登记记链后的返回的key值,对应链上版权唯一编号
workName string N 修改后作品名称
workCategory string N 修改后作品类别(详见作品类别枚举)
workCreateType string N 修改后作品创作性质(详见作品创作性质枚举)
rightObtainType string N 修改后权利取得方式(详见权利取得方式枚举)
rightHaveType string N 修改后权利拥有方式(详见权利拥有方式枚举)
authorType string N 作者类型(详见作者类型枚举)
authorName string N 作者名称
authorCertificateNo string N 作者证件号
workCompletionTime long N 修改后作品登记时间
work string N 新作品文件
workCategory string N 作品数据指纹
extendField string N 修改后扩展信息
Uid string Y 应用uid
sk string Y 私钥
参数 类型 是否必备 备注
status int Y 状态码(详见状态码定义)
msg string Y 提示信息
data ChainResDTO Y 返回数据(详见ChainResDTO说明)
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

log.info("版权修改:=========================");
CopyrightService.CopyrightUpdateReq dto = new CopyrightService.CopyrightUpdateReq();
dto.setUid(uid);
dto.setSk(sk);
dto.setAppId(appId);
dto.setKey(key);
dto.setWorkName("那人那山那狗");
dto.setAuthorName("天蚕土豆");
ChainResDTO resDTO = blockService.copyrightUpdate(dto);
log.info("版权修改成功,返回区块信息=[{}]", resDTO);

(2)智能合约协议

略

3.1.3通用存证

通用存证指用于版权存证之外如侵权任务、侵权证据、服务协议等各类通用型的数据存证格式。

协议流程:略。

(1)SDK接口

接口方法:evidenceAdd()

参数名称 参数类型 最大长度 是否必要 参数说明
eviName String Y 证据名称
evidenceType String Y 数据存证类型(1-侵权检测任务、2-侵权证据、0-其他)
val String 8096 Y 存证数据(数据或hash,用户自定义)
extendField String 512 N 扩展信息
version String 128 N 版本号
Uid string Y 应用uid
sk String 128 Y 私钥
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
key string 存证业务主键,由SDK生成,规则为bsi+evi+当前时间戳+4位随机数
message String 提示信息
data ChainResDTO 返回数据
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

log.info("新增通用存证============================");
EvidenceDTO dto = new EvidenceDTO();
setBaseParam(dto);
dto.setVal("ssss");
dto.setEvidenceType(EvidenceDTO.EvidenceType.OtherType);
dto.setVersion("0.0.1");
ChainResDTO resDTO = blockService.evidenceAdd(dto);
log.info("新增通用存证成功:key=[{}],区块返回信息=[{}]", resDTO.getKey(), resDTO);

(2)智能合约协议

略

3.1.4更新通用存证

(1)SDK接口

接口方法:evidenceUpdate()

参数名称 参数类型 最大长度 是否必要 参数说明
key string Y 证据编号
eviName String Y 证据名称
type String Y 数据存证类型(1-侵权检测任务、2-侵权证据、0-其他)
value String 8096 Y 存证数据
extendField String 512 N 扩展信息
version String 128 N 版本号
Uid string Y 应用uid
sk String Y 存证用户私钥
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTO 返回数据
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

public static void evidenceUpdateTest(){
    log.info("开始更新通用存证=======================");
    EvidenceService.EvidenceUpdate dto = new EvidenceService.EvidenceUpdate();
    setBaseParam(dto);
    dto.setKey(key);
    dto.setVal("tttt");
    dto.setEvidenceType(EvidenceDTO.EvidenceType.OtherType);
    dto.setVersion("0.0.2");
    ChainResDTO resDTO = blockService.evidenceUpdate(dto);
    log.info("通用存证更新成功,返回区块信息=[{}]",resDTO);
}

(2)智能合约协议

略

3.2 NFT

用于支持链上非同质化资产(NFT)的创建、转移、销毁等。

3.2.1资产发行计划

应用系统->SDK:资产发行计划
SDK->SDK:签名组装
SDK->链: 发行计划上链
链->链:验签,验证Key不重复
链->SDK:返回上链结果
SDK->应用系统:返回上链结果信息  

(1)SDK接口

接口名称:ntfReleasePlanAdd()

参数名称 参数类型 最大长度 是否必要 参数说明
Key String 128 Y 资产元数据,即metadata,一般可传入链上版权登记完成后的ID,用户自行传入
name String 128 Y 资产名称
symbol String 128 Y 资产符号
total Long 必须大于0 Y 总计划发行量
appkey String Y 发行方appkey(后续校验仅发行方可发行该资产)
Uid string Y 应用uid
sk String Y 应用用户私钥
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTOList 返回交易数据集合
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

log.info("新增nft发行计划");
        NftReleasePlanDTO dto = new NftReleasePlanDTO();
        setBaseParam(dto);
        dto.setName("加菲猫");
        dto.setKey(key);
        dto.setSymbol("nftdddd");
        dto.setProperty("100%");
        dto.setTotal(300000L);
ntfReleasePlanAdd(NftReleasePlanDTO);

(2)智能合约协议

略

3.2.2资产发行

资产发行前,必须先指定资产发行计划3.2.1,且调用方appkey为计划制定者appkey、有剩余发行余量。

应用系统->SDK:资产发行
SDK->SDK:签名组装
SDK->链: 资产发行
链->链:验签,校验资产元数据已制定资产发行计划,否则返回:无相应发行计划;
链->链:校验 发行方为同一appkey,否则返回:无发行权限;
链->链:根据发行总量N,分N次交易调用记链,并修改发行计划已发行数量实体,达到发行总量时,不能超额发行,否则返回:无法超额发行;
链->SDK:批量返回上链结果信息(N条交易)
SDK->应用系统:返回上链结果信息  

(1)SDK接口

接口名称:nftIssue()

批量发行,采用异步方式,传入需要回调的方法

参数名称 参数类型 最大长度 是否必要 参数说明
nftdto NftDTO Y 资产业务数据
success Consumer<List> Y 成功回调函数
err Consumer<List> Y 异常回调函数
参数名称 参数类型 最大长度 是否必要 参数说明
metadata String 128 Y 资产元数据,一般业务为版权Key、发行计划Key
thisTotal 大于0小于500 Y 本次发行量
price 必须为两位小数 Y 发行价
assetProportions List Y 资产所有人(自定义结构数组,包含资产接收方pk与所占份额,总份额必须为100%。)如:pk1,20%,pk2,80%。
sk String Y 存证用户私钥
uId String Y 用户Id
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
keyList list 链上资产编号集合
data ChainResDTOList 返回交易数据集合
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

// 成功回调函数
public static void success(List<NftService.NftChainResDTO> list){
        System.out.println("成功回调"+list.size());
}
//失败回调函数
    public static void err(List<SdkLunaException> list){
        System.out.println("失败回调"+list.size());
    }
//调用
nftAdd(nftdto,(List<NftService.NftChainResDTO> resList)->{success(resList);},(List<SdkLunaException> err)->{err(err);});

(2)智能合约协议(合约内并发执行,高TPS)

略

3.2.2资产转移

应用系统->SDK:资产转移
SDK-链数据解析服务:验证key存在,资产状态正常,且资产所属人转移份额不大于自身持有份额
链数据解析服务-SDK:返回验证结果或报错信息
SDK->SDK:签名组装
SDK->链: 资产转移
链->链:验签,更新资产所有人信息,记链
链->SDK:返回上链结果信息
SDK->应用系统:返回上链结果信息  

(1)SDK接口

接口名称:nftTransfer()

参数名称 参数类型 最大长度 是否必要 参数说明
key String Y 资产编号
toaddress String Y 资产接收方用户pk
transProportion String 3 Y 转移份额,1-100%
sk String Y 用户私钥
uId String Y 用户Id
finalPrice String 必须带两位小数 Y 成交价
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTO 返回数据
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

log.info("nft资产转移:===================");
NftService.NftTransParam dto = new NftService.NftTrans();
setBaseParam(dto);
dto.setKey(key);
dto.setToAddress("zc002");
dto.setTransProportion("80");
dto.setFinalPrice("9.00");
ChainResDTO resDTO = blockService.nftTransfer(dto);
log.info("nft资产转移完成,区块返回信息=[{}]",resDTO);

(2)智能合约协议

略

3.2.2资产转移(批量 )

(1)SDK接口

接口名称:nftTransfer()

参数名称 参数类型 最大长度 是否必要 参数说明
keyList List Y 资产编号结合
toaddressList List Y 资产接收方用户pk集合
transProportion String 3 Y 转移份额,1-100%
sk String Y 用户私钥
appId String Y 应用Id
uId String Y 用户Id
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTOLIST 返回数据,每个资产最新的交易hash
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:

3.2.3资产销毁

Title: NFT资产销毁
应用系统->SDK:资产销毁
SDK-链数据解析服务:验证key存在,且资产100%份额属于当前用户
链数据解析服务-SDK:返回验证结果或报错信息
SDK->SDK:签名组装
SDK->链: 资产销毁
链->链:验签,更新资产状态信息,记链
链->SDK:返回上链结果信息
SDK->应用系统:返回上链结果信息  

(1)SDK接口

接口名称:nftDestroy()

参数名称 参数类型 是否必要 参数说明
key String Y 资产编号
sk String Y 用户私钥
uId String Y 用户Id
参数名称 参数类型 参数说明
isOk Boolean 业务操作结果
message String 提示信息
data ChainResDTO 返回数据
参数名称 参数类型 参数说明
code integer 异常值
message String 异常消息
data Map<String,Object> 根据值“transactionId”可以获取 交易hash,查询交易是否已上链

示例代码:


}

(2)智能合约协议

略

3.3 版权侵权处理

略

四、解析查询接口设计

1.概述

解析查询服务,为方便新版链前端浏览器、各类钱包应用商、交易平台及有需要的业务系统,调用接口,查询链上的数据、资产详情。

2. 接口明细

2.1 根据交易hash查询业务主体

接口地址:~/api/base/query/bus/tx_hash/table/list

请求方式:GET

请求数据类型:*/*

响应数据类型:application/json

接口描述:根据交易hash查询该交易的类型是用户存证,版权存证,NFT或者其他类型业务主体。

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
token 权限token header true string
hash 交易hash query true string

响应状态:

状态码 说明
200 OK

响应参数:

参数名称 参数说明 类型
code 状态码 integer(int32)
data 数据主体 Business
  database 链与合约 string
  id 业务主体ID string
  table 链上业务实体表名 string
  txId 交易hash string

响应示例:

{
    "data": [
        {
            "id": "fe83cb01bda1113532d695afb0be02a6",
            "dataHash": null,
            "txId": "1636512362104d03f214af......",
            "database": "chain_xblchain-org1-test-com_xblgo-org1-test-com",
            "table": "xbl_datafinger"
        },
        {
            "id": "c1049b390515d5974da705dfc654194c",
            "dataHash": null,
            "txId": "1636512362104d03f214af......",
            "database": "chain_xblchain-org1-test-com_xblgo-org1-test-com",
            "table": "xbl_evidence"
        }
    ],
    "code": 200,
    "message": "success"
}

2.2 数据详情查询

接口地址:~/api/service/open/monitor/query

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:支持根据交易hash、业务主键key、用户ID等查询链上交易详细信息

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
token 权限token header true string
req req body true QueryReq
 table 查询的交易业务主体表名,可由接口1查询。(如版权信息:xbl_copyright,通用存证:xbl_evidence,NFT信息:xbl_nft) true string
 field 查询字段名(如编号:Key等等) true string
 value 查询条件value(精确查询字段值) true string
 top top= 1,表示最新状态,top>1 溯源查询 true integer(int32)

响应状态:

状态码 说明
200 OK

响应参数:

参数名称 参数说明 类型 schema
code 状态码 integer(int32) integer(int32)
data 数据主体 array
message 说明 string

响应示例:

{
    "data": [
        {
            "_id": "61766f0c718......",
            "chain_block_tx_id": "163515294719947b......",
            "Key": "82BSI8255297cop16346352348978699",
            "_bus_table": "xbl_copyright",
            .............
        }
    ],
    "code": 200,
    "message": "success"
}

2.3 存证证书下载

接口地址:~/api/service/open/user/get/cert

请求方式:GET

请求数据类型:*/*

响应数据类型:image/png

接口描述:以交易hash,下载链上资产存证证书

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
token 权限token header true string
txHash 交易hash query true string

响应状态:

状态码 说明
200 OK

响应参数:

参数名称 参数说明 类型
File 证书图片 image/png

2.5 根据资产源数据,查询NFT发行情况

接口描述:根据源数据,查询当前源数据总共发行的所有NFT(200条翻页(ID去重且为最新))

​ 请求:metaData、token

​ 返回:{已发行总量,{NFT1最新信息:NFTID、所属人及份额、交易时间、交易hash、区块高度},{NFT2最新信息:}……}}

2.6 根据公钥地址,查询NFT拥有情况

接口描述:根据地址(资产所属人pk),返回该地址当前拥有的所有NFT信息(200条翻页),是否可在资产发行即在对应账户地址下,添加拥有的资产信息。转移时,在两个账户下对应做资产的变更且作交易记录。**

​ 请求:pk、token

​ 返回:{{NFT1最新信息:NFTID、拥有份额、交易时间、交易hash、区块高度},{NFT2最新信息:}……}}

2.7 根据公钥地址,查询交易记录

接口描述:根据地址(资产所属人pk),返回该地址目前所有的交易记录。(转出地址、转入地址、转移份额、NFT、交易时间),可能需要每次交易,都在对应地址上,记录一次交易记录,即增加账户地址的交易记录表。**

​ 请求:pk、token

​ 返回:{交易记录1:NFTKey、转出/转入、转出转入/地址、转移份额、交易时间、交易hash、区块高度},{交易记录2:},{交易记录3:}……

2.7 根据nft,查询交易记录(new)

接口描述:根据nftID,返回该资产所有的变更记录,即对应nft下记录每次交易。

​ 请求:Key、token

​ 返回:{交易记录1:转出地址、转入地址,转移份额、交易时间、交易hash、区块高度},{交易记录2:},{交易记录3:}……

2.8 根据时间范围,查询全网交易记录(new)

接口描述:根据nftID,返回该资产所有的变更记录,即对应nft下记录每次交易。

​ 请求:时间范围(最多三个月)、分页、token

​ 返回:{交易数,{交易记录1:转出地址、转入地址,转移份额、交易时间、交易hash、区块高度},{交易记录2:},{交易记录3:}……

3. 接口示例

3.1 根据交易hash获得业务主体数据

使用 查询业务主体(根据交易hash)接口(2.1)

......url?hash=163515294719947b......

返回数据

{
    "data": {
        "id": "......",
        "dataHash": null,
        "txId": "163515294719947b......",
        "database": "chain_......",
        "table": "xbl_copyright"
    },
    "code": 200,
    "message": "success"
}

3.2 根据链上资产id查询最新存证

使用 数据查询 接口(2.2)

{
  "table": "xbl_copyright",
  "field": "Key",
  "value": "链上资产id",
  "top": 1
}

3.3 根据交易hash查询链上数据

① 第一步,根据交易hash查询交易业务主体

使用 查询业务主体(根据交易hash)接口(2.1)

......url?hash=163515294719947b......

返回数据

{
    "data": {
        "id": "......",
        "dataHash": null,
        "txId": "163515294719947b......",
        "database": "chain_......",
        "table": "xbl_copyright"
    },
    "code": 200,
    "message": "success"
}

① 第二步,根据交易hash和table查询链上数据

使用 数据查询 接口(2.2)

{
  "table": "第一步调用结果中返回属性'table'的值",
  "field": "chain_block_tx_id",
  "value": "交易hash",
  "top": 1
}

3.4 链上数据溯源

根据交易hash进行数据存证溯源

使用 数据查询 接口(2.2),参数与3.3一样,只需调整参数“top”的值(top值即溯源的条数,最大200),示例如下:

{
  "table": "第一步调用结果中返回属性'table'的值",
  "field": "chain_block_tx_id",
  "value": "交易hash",
  "top": 20
}

3.5 存证证书下载

根据交易hash进行存证证书下载

请求示例:

使用 存证证书下载接口(2.3)

......url?txHash=163515294719947b......

其他接口待补充

五、接口及枚举补充说明

5.1 通用返回ChainResDTO

参数名称 参数类型 备注
transactionId String 交易hash(异常时必备)
previousHash String 前一区块hash
dataHash String 区块哈希
time String 记链时间
timestamp Date 记链时间戳
height Long 区块高度

AssetProportion 资产份额占比实体

参数名称 参数类型 备注
pk string 公钥
proportion string 份额比例

5.2 枚举