跳轉至

資產 API 提供註冊和檢索有關資產的信息,例如媒體文件。

上傳資產

上傳資產(如 jpg、png、gif 等媒體文件)到公共 IPFS(星際文件系統)。它提供上傳資產的 IPFS 地址(uri)和可以通過 HTTP 訪問的網關地址(gatewayUrl)。

請求 URL

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

標頭參數

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

請求主體

欄位名稱 描述 類型 必填
asset 要上傳的媒體檔案的二進位資訊 字串

回應

欄位名稱 描述 類型
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/asset' 
  -H 'accept: application/json' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO' 
  -H 'Content-Type: multipart/form-data' 
  -F 'asset=@cw20.code'

回應範例

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

使用公共 URL 上傳資產

將資產(如 jpg、png、gif 等媒體文件)上傳到公共 IPFS。不是直接上傳文件,而是通過公共 URL 上傳。它提供了上傳資產的 IPFS 地址(uri)和可以通過 HTTP 訪問的網關地址(gatewayUrl)。

請求 URL

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

標頭參數

欄位名稱 描述 類型 必需
授權 認證令牌,呼叫 API 時需要 字串

請求主體

欄位名稱 描述 類型 必需
url 資產將上傳到的公共 URL 字串 Y

回應

欄位名稱 描述 類型
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/asset-by-url' 
  -H 'accept: application/json' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO' 
  -H 'Content-Type: application/json' 
  -d '{
  "url": "https://image01.c2x.world/equip_92053030.gif"
}'

回應範例

{
  "code": 0,
  "message": "success",
  "data": {
    "contentType": "image/gif",
    "uri": "ipfs://QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF",
    "gatewayUrl": "https://sandbox-bc-file.qpyou.cn/ipfs/QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF"
  }
}

獲取資產資訊

透過內容識別碼(cid)獲取資產 URL,公開訪問。

請求 URL

直播網址 https://bc-api.qpyou.cn/core/v1/asset/{cid}
沙盒網址 https://sandbox-bc-api.qpyou.cn/core/v1/asset/{cid}
HTTP 方法 GET
內容類型 application/json

標頭參數

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

路徑參數

欄位名稱 描述 類型 是否必填
cid 這是 IPFS 內容識別碼。這是用於識別 IPFS 中數據的哈希值,可以在 uri(ipfs://{CID}) 或 gatewayUrl(https://{GATEWAY_URL}/ipfs/{CID}) 中找到。 字串

回應

欄位名稱 描述 類型
code API 請求結果代碼,0:成功 數字
message 結果消息 字串
data API 回應數據 json
data.assetUri 可以找到資產的網關地址 字串

請求範例

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

回應範例

{
  "code": 0,
  "message": "success",
  "data": {
    "assetUri": "https://sandbox-bc-file.qpyou.cn/ipfs/QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF"
  }
}