API 元数据

元数据 API 提供元数据上传和信息搜索功能。

上传元数据¶

将元数据上传到公共IPFS。它提供了上传的元数据IPFS的地址（uri）和可以通过HTTP访问的网关地址（gatewayUrl）。

请求 URL¶

实时 URL	https://bc-api.qpyou.cn/core/v1/metadata
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/metadata
HTTP 方法	POST
内容类型	application/json

头部参数¶

字段名称	描述	类型	必需
授权	调用API所需的身份验证令牌	字符串	是

请求体¶

字段名称	描述	类型	必需
name	NFT 名称	字符串	是
description	NFT 描述	字符串	否
image	这是 NFT 图像地址。这是公共网站地址或用于将图像上传到 IPFS 的公共 IPFS 地址。	字符串	是
animationUrl	NFT 动画的地址	字符串	否
youtubeUrl	YouTube 地址	字符串	否
imageData	NFT 图像信息	字符串	否
externalUrl	外部 URL	字符串	否
backgroundColor	代币的背景颜色信息（OpenSea）	字符串	否
attributes	这些是元数据属性的信息。这些包含附加信息，这些信息在元数据中未描述。	json	否
attributes.traitType	构成属性的项目名称	字符串	否
attributes.maxValue	特征的最大值	数字	否
attributes.value	这是特征值。它应小于 `attributes.maxValue`。如果 `attributes.displayType` 是日期，请按照 unix 时间戳（秒）格式设置此值。	字符串或数字	否
attributes.displayType	这是特征的显示类型。默认值是字符串。 number: 数值类型 boost_percentage: 百分比（OpenSea Boosts） boost_number: 数值（OpenSea Boosts） date: 日期类型（示例：2019年1月1日，星期二）	字符串	否

响应¶

字段名称	描述	类型
code	api 请求结果代码，0：成功	number
message	结果消息	String
data	API 响应数据	json
data.contentType	内容类型	string
data.uri	元数据上传的 IPFS 地址	string
data.gatewayUrl	可以找到元数据的网关地址	string

请求示例¶

curl -X 'POST' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/metadata' 
  -H 'accept: application/json' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO' 
  -H 'Content-Type: application/json' 
  -d '{
  "name": "Arbiter'''s Robe",
  "description": "desc",
  "image": "https://image01.c2x.world/equip_92053030.gif",
  "animationUrl": "https://image01.c2x.world/equip_92053030.gif",
  "youtubeUrl": "https://www.youtube.com",
  "externalUrl": "https://dex.c2xnft.com/market?key=4423",
  "backgroundColor": "##ffffff",
  "attributes": [
    {
      "traitType": "traitType",
      "maxValue": "10",
      "value": "1",
      "displayType": "displayType"
    }
  ]
}'

响应示例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "contentType": "application/json",
    "uri": "ipfs://QmfAsGExBG8kChweQtZcKZWqUxC4qBYhyWVokE5EQHoyWS",
    "gatewayUrl": "https://sandbox-bc-file.qpyou.cn/ipfs/QmfAsGExBG8kChweQtZcKZWqUxC4qBYhyWVokE5EQHoyWS"
  }
}

获取元数据的信息¶

通过内容标识符(cid)获取元数据。

请求 URL¶

直播 URL	https://bc-api.qpyou.cn/core/v1/metadata/{cid}
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/metadata/{cid}
HTTP 方法	GET
内容类型	application/json

头部参数¶

字段名称	描述	类型	必需
授权	调用API所需的身份验证令牌	字符串	是

路径参数¶

字段名称	描述	类型	必需
cid	这是 IPFS 内容标识符。这是用于标识 IPFS 中数据的哈希值，可以在 `uri`(ipfs://{CID}) 或 `gatewayUrl`(https://{GATEWAY_URL}/ipfs/{CID}) 中找到。	字符串	是

响应¶

字段名称	描述	类型
code	api 请求结果代码，0：成功	number
message	结果消息	String
data	元数据	json
data.uri	元数据的 IPFS 地址	string
data.gatewayUrl	元数据的网关地址	string
data.metadata	元数据	json
data.metadata.name	NFT 名称	string
data.metadata.description	NFT 描述	string
data.metadata.image	这是 NFT 图像地址。这是公共网站地址或公共 IPFS 地址。	string
data.metadata.animationUrl	NFT 动画的地址	string
data.metadata.youtubeUrl	Youtube 地址	string
data.metadata.imageData	NFT 图像信息	string
data.metadata.externalUrl	外部网址	string
data.metadata.backgroundColor	代币的背景颜色信息 (OpenSea)	string
data.metadata.attributes	这些是元数据属性的信息。这些包含附加信息，这些信息未在元数据中描述。	json
data.metadata.attributes.traitType	构成属性的项目名称	string
data.metadata.attributes.maxValue	属性的最大值	number
data.metadata.attributes.value	这是属性值。它应该小于 `data.metadata.attributes.maxValue`。如果 `data.metadata.attributes.displayType` 是日期，请按照 unix 时间戳（秒）格式设置此值。	string or number
data.metadata.attributes.displayType	这是属性的显示类型。默认值是字符串。 number: 数值类型 boost_percentage: 百分比 (OpenSea Boosts) boost_number: 数值 (OpenSea Boosts) date: 日期类型（示例：2019 年 1 月 1 日，星期二）	string

请求示例¶

curl -X 'GET' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/metadata/QmfAsGExBG8kChweQtZcKZWqUxC4qBYhyWVokE5EQHoyWS' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO' 
  -H 'accept: application/json'

响应示例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "uri": "ipfs://QmfAsGExBG8kChweQtZcKZWqUxC4qBYhyWVokE5EQHoyWS",
    "gatewayUrl": "https://sandbox-bc-file.qpyou.cn/ipfs/QmfAsGExBG8kChweQtZcKZWqUxC4qBYhyWVokE5EQHoyWS",
    "metadata": {
      "name": "Arbiter's Robe",
      "description": "desc",
      "image": "https://image01.c2x.world/equip_92053030.gif",
      "animationUrl": "https://image01.c2x.world/equip_92053030.gif",
      "youtubeUrl": "https://www.youtube.com",
      "externalUrl": "https://dex.c2xnft.com/market?key=4423",
      "backgroundColor": "##ffffff",
      "attributes": [
        {
          "traitType": "traitType",
          "maxValue": "10",
          "value": "1",
          "displayType": "displayType"
        }
      ]
    }
  }
}