跳到主要内容

发行平台接口

创建数字资产资料

接口地址: /yeefox-wallet/createArchive

请求方式: POST

输入参数(JSON格式):

参数名称类型是否必填描述约束条件
chainStringchain不能为空(wenchuangchain)
publishCountInteger数字资产发布数量不能为空,且不能小于 1
archiveImageString数字资产图片地址不能为空
archiveNameString数字资产名不能为空
issueTimeString发行时间不能为空,格式为 yyyy-MM-dd HH:mm:ss
archiveDescriptionString资料描述不能为空
classIdString分类 id-
uniqueCodeString唯一标识不能为空
seriesTitleString系列名不能为空
issuerString发行方-
issuerDescriptionString发行方简介-
copyRightString版权方-
copyRightDescriptionString版权方简介-
copyRightAuthString版权认证方-
copyRightAuthDescriptionString版权认证方简介-
supportString技术支持-
remarkString备注-
introduceString介绍-
authorNameString作者名称-
authorDescriptionString作者简介-
seriesDescriptionString系列描述-

请求示例:

{
"chain": "wenchuangchain",
"publishCount": 1000,
"archiveImage": "https://example.com/images/historical-document.jpg",
"archiveName": "民国时期上海海关资料",
"issueTime": "2023-10-15 09:30:00",
"archiveDescription": "此资料记录了1927-1937年间上海海关的进出口贸易数据,具有重要历史研究价值",
"classId": "CLS_HISTORICAL_002",
"uniqueCode": "ARC-20231015-0001",
"seriesTitle": "近代中国海关资料系列",
"issuer": "国家资料馆",
"issuerDescription": "负责保管和管理国家重要资料的机构",
"copyRight": "国家资料馆",
"copyRightDescription": "拥有该资料的数字版权和实体保管权",
"copyRightAuth": "国家版权局",
"copyRightAuthDescription": "国家版权局对该资料的数字版权进行了认证",
"support": "XX科技公司",
"remark": "首批数字化资料之一",
"introduce": "本资料是研究近代中国对外贸易的重要史料,详细记录了当时的商品种类、交易量和关税情况",
"authorName": "上海海关总署(原)",
"authorDescription": "1927-1937年间的上海海关行政机构",
"seriesDescription": "该系列包含1840-1949年间中国各主要海关的资料,共计2000余件"
}

响应参数:

参数名称类型是否必填描述约束条件
archiveIdString资料 ID-
actionString操作类型取值为 "create"(创建)或 "update"(更新)

查询数字资产资料

接口地址: /yeefox-wallet/queryArchive

请求方式: GET/POST

输入参数:

参数名称类型是否必填描述约束条件
chainString链代码-
pageNumint页码默认为 1,需大于等于 1
pageSizeint每页条数默认为 20,需大于等于 1

响应参数:

参数名称类型是否必填描述示例
pageNumInteger页码1
pageSizeInteger每页条数20
totalCountint总记录数100
dataListList<QueryArchiveListResp>资料列表数据-

QueryArchiveListResp 数据结构:

参数名称类型是否必填描述格式/示例
archiveIdString资料 id"ARC123456"
chainString链代码"ARCHIVE_CHAIN_001"
publishCountInteger数字资产发布数量1000
archiveImageString资料图片地址"https://example.com/image.jpg"
archiveNameString资料名"民国时期上海海关资料"
issueTimeLocalDateTime发行时间yyyy-MM-dd HH:mm:ss(如:2023-10-15 09:30:00)
archiveDescriptionString资料描述"此资料记录了重要历史数据"
classIdString分类 id"CLS_HISTORICAL_002"
uniqueCodeString唯一标识"ARC-20231015-0001"
seriesTitleString系列名"近代中国海关资料系列"
issuerString发行方"国家资料馆"
issuerDescriptionString发行方简介"负责保管国家重要资料的机构"
copyRightString版权方"国家资料馆"
copyRightDescriptionString版权方简介"拥有该资料的数字版权"
copyRightAuthString版权认证方"国家版权局"
copyRightAuthDescriptionString版权认证方简介"对该资料的数字版权进行了认证"
supportString技术支持"XX 科技公司"
remarkString备注"首批数字化资料之一"
introduceString介绍"本资料是研究近代贸易的重要史料"
authorNameString作者名称"上海海关总署(原)"
authorDescriptionString作者简介"1927-1937 年间的上海海关行政机构"
seriesDescriptionString系列描述"该系列包含 2000 余件资料资料"

导入用户(异步接口)

接口地址: /yeefox-wallet/createWallet

请求方式: POST

输入参数:

参数名称类型是否必填描述约束条件
chainString区块链标识不能为空
idCardString身份证号-
phoneString手机号不能为空
realNameString真实姓名-
customString自定义信息(可用于回调时使用)-
privateKeyString私钥-

异步回调参数:

参数名称类型描述
addressString地址信息
chainString区块链标识
customString自定义信息

通知转移信息

接口地址: /yeefox-wallet/syncNft

请求方式: POST

输入参数:

参数名称类型是否必填描述约束条件
dacIdStringdacId不能为空
hashStringHash不能为空
chainString链名称不能为空

响应参数:

参数名称类型是否必填
dacIdString-

通知地址数字资产变动

接口地址: /yeefox-wallet/syncAddressNft

请求方式: POST

输入参数:

参数名称类型是否必填描述约束条件
addressString地址不能为空
chainString链名称不能为空

响应参数:

参数名称类型描述
addressString地址
chainString链名称