コンテンツにスキップ

アセットAPIは、メディアファイルのようなアセットに関する情報を登録および取得することを提供します。

アセットをアップロード¶

アップロードされたアセット（jpg、png、gifなどのメディアファイル）をパブリックIPFS（InterPlanetary File System）にアップロードします。アップロードされたアセットのIPFSのアドレス（uri）と、HTTP経由でアクセス可能なゲートウェイアドレス（gatewayUrl）を提供します。

リクエストURL¶

ライブURL	https://bc-api.qpyou.cn/core/v1/asset
サンドボックスURL	https://sandbox-bc-api.qpyou.cn/core/v1/asset
HTTPメソッド	POST
コンテンツタイプ	application/json

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	APIを呼び出すために必要な認証トークン	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
asset	アップロードされるメディアファイルに関するバイナリ情報	文字列	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' 
  -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

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	APIを呼び出すために必要な認証トークン	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
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¶

ライブ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

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	APIを呼び出すために必要な認証トークン	文字列	Y

パスパラメータ¶

フィールド名	説明	タイプ	必須
cid	これはIPFSコンテンツ識別子です。これはIPFS内のデータを識別するために使用されるハッシュ値であり、`uri`(ipfs://{CID})または`gatewayUrl`(https://{GATEWAY_URL}/ipfs/{CID})で見つけることができます。	文字列	Y

応答¶

フィールド名	説明	タイプ
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"
  }
}