跳转至

资产 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所需的身份验证令牌 字符串

请求体

字段名称 描述 类型 必需
asset 要上传的媒体文件的二进制信息 字符串 Y

响应

字段名称 描述 类型
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/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

直播 URL https://bc-api.qpyou.cn/core/v1/asset-by-url
沙盒 URL https://sandbox-bc-api.qpyou.cn/core/v1/asset-by-url
HTTP 方法 POST
内容类型 application/json

头部参数

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

请求体

字段名称 描述 类型 必需
url 将上传资产的公共 URL 字符串 Y

响应

字段名称 描述 类型
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/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

直播 URL https://bc-api.qpyou.cn/core/v1/asset/{cid}
沙盒 URL https://sandbox-bc-api.qpyou.cn/core/v1/asset/{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 API响应数据 json
data.assetUri 可以找到资产的网关地址 string

请求示例

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