元數據 API

元數據 API 提供元數據上傳和搜索其信息的功能。

上傳元數據¶

將元數據上傳到公共 IPFS。它提供了上傳的元數據 IPFS 的地址（uri）和可以通過 HTTP 訪問的網關地址（gatewayUrl）。

請求 URL¶

直播網址	https://bc-api.qpyou.cn/core/v1/metadata
沙盒網址	https://sandbox-bc-api.qpyou.cn/core/v1/metadata
HTTP 方法	POST
內容類型	application/json

標頭參數¶

欄位名稱	描述	類型	必需
授權	認證令牌，呼叫 API 所需	字串	Y

請求主體¶

欄位名稱	描述	類型	必需
name	NFT 名稱	字串	Y
description	NFT 描述	字串	N
image	這是 NFT 圖像地址。這是上傳圖像到 IPFS 的公共網站地址或公共 IPFS 地址。	字串	Y
animationUrl	NFT 動畫的地址	字串	N
youtubeUrl	Youtube 地址	字串	N
imageData	NFT 圖像信息	字串	N
externalUrl	外部網址	字串	N
backgroundColor	代幣的背景顏色信息 (OpenSea)	字串	N
attributes	這些是元數據屬性的資訊。這些包含附加信息，這些信息在元數據中未描述。	json	N
attributes.traitType	構成屬性的項目名稱	字串	N
attributes.maxValue	屬性的最大值	數字	N
attributes.value	這是屬性值。它應小於 `attributes.maxValue`。如果 `attributes.displayType` 是日期，請按照 unix 時戳（秒）格式設置此值。	字串或數字	N
attributes.displayType	這是屬性的顯示類型。默認值是字串。數字: 數值類型 boost_percentage: 百分比 (OpenSea Boosts) boost_number: 數字 (OpenSea Boosts) 日期: 日期類型 (範例: 2019 年 1 月 1 日，星期二)	字串	N

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.contentType	內容類型	字串
data.uri	上傳元數據的 IPFS 地址	字串
data.gatewayUrl	可以找到元數據的網關地址	字串

請求範例¶

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：成功	數字
message	結果消息	字串
data	元數據信息	json
data.uri	元數據的 IPFS 地址	字串
data.gatewayUrl	元數據的網關地址	字串
data.metadata	元數據	json
data.metadata.name	NFT 名稱	字串
data.metadata.description	NFT 描述	字串
data.metadata.image	這是 NFT 圖像地址。這是公共網站地址或公共 IPFS 地址。	字串
data.metadata.animationUrl	NFT 動畫的地址	字串
data.metadata.youtubeUrl	Youtube 地址	字串
data.metadata.imageData	NFT 圖像信息	字串
data.metadata.externalUrl	外部網址	字串
data.metadata.backgroundColor	代幣的背景顏色信息 (OpenSea)	字串
data.metadata.attributes	這些是元數據屬性的資訊。這些包含附加信息，這些信息在元數據中未描述。	json
data.metadata.attributes.traitType	構成屬性的項目名稱	字串
data.metadata.attributes.maxValue	屬性的最大值	數字
data.metadata.attributes.value	這是屬性值。它應該小於 `data.metadata.attributes.maxValue`。如果 `data.metadata.attributes.displayType` 是日期，則將此值設置為 unix 時間戳（秒）格式。	字串或數字
data.metadata.attributes.displayType	這是屬性的顯示類型。默認值是字串。數字：數字類型 boost_percentage：百分比 (OpenSea Boosts) boost_number：數字 (OpenSea Boosts) 日期：日期類型（示例：2019年1月1日，星期二）	字串

請求範例¶

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"
        }
      ]
    }
  }
}