发行平台接口
创建数字资产资料
接口地址: /yeefox-wallet/createArchive
请求方式: POST
输入参数(JSON格式):
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| chain | String | 是 | chain | 不能为空(wenchuangchain) |
| publishCount | Integer | 是 | 数字资产发布数量 | 不能为空,且不能小于 1 |
| archiveImage | String | 是 | 数字资产图片地址 | 不能为空 |
| archiveName | String | 是 | 数字资产名 | 不能为空 |
| issueTime | String | 是 | 发行时间 | 不能为空,格式为 yyyy-MM-dd HH:mm:ss |
| archiveDescription | String | 是 | 资料描述 | 不能为空 |
| classId | String | 是 | 分类 id | - |
| uniqueCode | String | 是 | 唯一标识 | 不能为空 |
| seriesTitle | String | 是 | 系列名 | 不能为空 |
| issuer | String | 否 | 发行方 | - |
| issuerDescription | String | 否 | 发行方简介 | - |
| copyRight | String | 否 | 版权方 | - |
| copyRightDescription | String | 否 | 版权方简介 | - |
| copyRightAuth | String | 否 | 版权认证方 | - |
| copyRightAuthDescription | String | 否 | 版权认证方简介 | - |
| support | String | 否 | 技术支持 | - |
| remark | String | 否 | 备注 | - |
| introduce | String | 否 | 介绍 | - |
| authorName | String | 否 | 作者名称 | - |
| authorDescription | String | 否 | 作者简介 | - |
| seriesDescription | String | 否 | 系列描述 | - |
请求示例:
{
"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余件"
}
响应参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| archiveId | String | 否 | 资料 ID | - |
| action | String | 否 | 操作类型 | 取值为 "create"(创建)或 "update"(更新) |
查询数字资产资料
接口地址: /yeefox-wallet/queryArchive
请求方式: GET/POST
输入参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| chain | String | 否 | 链代码 | - |
| pageNum | int | 是 | 页码 | 默认为 1,需大于等于 1 |
| pageSize | int | 是 | 每页条数 | 默认为 20,需大于等于 1 |
响应参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| pageNum | Integer | 是 | 页码 | 1 |
| pageSize | Integer | 是 | 每页条数 | 20 |
| totalCount | int | 是 | 总记录数 | 100 |
| dataList | List<QueryArchiveListResp> | 是 | 资料列表数据 | - |
QueryArchiveListResp 数据结构:
| 参数名称 | 类型 | 是否必填 | 描述 | 格式/示例 |
|---|---|---|---|---|
| archiveId | String | 是 | 资料 id | "ARC123456" |
| chain | String | 否 | 链代码 | "ARCHIVE_CHAIN_001" |
| publishCount | Integer | 是 | 数字资产发布数量 | 1000 |
| archiveImage | String | 是 | 资料图片地址 | "https://example.com/image.jpg" |
| archiveName | String | 是 | 资料名 | "民国时期上海海关资料" |
| issueTime | LocalDateTime | 是 | 发行时间 | yyyy-MM-dd HH:mm:ss(如:2023-10-15 09:30:00) |
| archiveDescription | String | 是 | 资料描述 | "此资料记录了重要历史数据" |
| classId | String | 是 | 分类 id | "CLS_HISTORICAL_002" |
| uniqueCode | String | 是 | 唯一标识 | "ARC-20231015-0001" |
| seriesTitle | String | 是 | 系列名 | "近代中国海关资料系列" |
| issuer | String | 否 | 发行方 | "国家资料馆" |
| issuerDescription | String | 否 | 发行方简介 | "负责保管国家重要资料的机构" |
| copyRight | String | 否 | 版权方 | "国家资料馆" |
| copyRightDescription | String | 否 | 版权方简介 | "拥有该资料的数字版权" |
| copyRightAuth | String | 否 | 版权认证方 | "国家版权局" |
| copyRightAuthDescription | String | 否 | 版权认证方简介 | "对该资料的数字版权进行了认证" |
| support | String | 否 | 技术支持 | "XX 科技公司" |
| remark | String | 否 | 备注 | "首批数字化资料之一" |
| introduce | String | 否 | 介绍 | "本资料是研究近代贸易的重要史料" |
| authorName | String | 否 | 作者名称 | "上海海关总署(原)" |
| authorDescription | String | 否 | 作者简介 | "1927-1937 年间的上海海关行政机构" |
| seriesDescription | String | 否 | 系列描述 | "该系列包含 2000 余件资料资料" |
导入用户(异步接口)
接口地址: /yeefox-wallet/createWallet
请求方式: POST
输入参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| chain | String | 是 | 区块链标识 | 不能为空 |
| idCard | String | 否 | 身份证号 | - |
| phone | String | 是 | 手机号 | 不能为空 |
| realName | String | 否 | 真实姓名 | - |
| custom | String | 否 | 自定义信息(可用于回调时使用) | - |
| privateKey | String | 否 | 私钥 | - |
异步回调参数:
| 参数名称 | 类型 | 描述 |
|---|---|---|
| address | String | 地址信息 |
| chain | String | 区块链标识 |
| custom | String | 自定义信息 |
通知转移信息
接口地址: /yeefox-wallet/syncNft
请求方式: POST
输入参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| dacId | String | 是 | dacId | 不能为空 |
| hash | String | 是 | Hash | 不能为空 |
| chain | String | 是 | 链名称 | 不能为空 |
响应参数:
| 参数名称 | 类型 | 是否必填 |
|---|---|---|
| dacId | String | - |
通知地址数字资产变动
接口地址: /yeefox-wallet/syncAddressNft
请求方式: POST
输入参数:
| 参数名称 | 类型 | 是否必填 | 描述 | 约束条件 |
|---|---|---|---|---|
| address | String | 是 | 地址 | 不能为空 |
| chain | String | 是 | 链名称 | 不能为空 |
响应参数:
| 参数名称 | 类型 | 描述 |
|---|---|---|
| address | String | 地址 |
| chain | String | 链名称 |