コンテンツにスキップ

メタデータ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

ヘッダーパラメータ¶

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

リクエストボディ¶

フィールド名	説明	タイプ	必須
name	NFTの名前	文字列	Y
description	NFTの説明	文字列	N
image	これはNFTの画像アドレスです。これは、画像をIPFSにアップロードするための公開ウェブサイトアドレスまたは公開IPFSアドレスです。	文字列	Y
animationUrl	NFTアニメーションのアドレス	文字列	N
youtubeUrl	Youtubeのアドレス	文字列	N
imageData	NFT画像情報	文字列	N
externalUrl	外部URL	文字列	N
backgroundColor	トークンの背景色情報 (OpenSea)	文字列	N
attributes	これらはメタデータ属性の情報です。これには、メタデータに記載されていない追加情報が含まれています。	json	N
attributes.traitType	属性を構成するアイテムの名前	文字列	N
attributes.maxValue	特性の最大値	数値	N
attributes.value	これは特性の値です。`attributes.maxValue`より小さい必要があります。`attributes.displayType`が日付の場合、この値はUnixタイムスタンプ（秒）形式に従って設定してください。	文字列または数値	N
attributes.displayType	これは特性の表示タイプです。デフォルト値は文字列です。 number: 数値タイプ boost_percentage: パーセンテージ (OpenSea Boosts) boost_number: 数値 (OpenSea Boosts) date: 日付タイプ (例: 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

ヘッダーパラメータ¶

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

パスパラメータ¶

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

応答¶

フィールド名	説明	タイプ
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	外部URL	文字列
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	これは特性の表示タイプです。デフォルト値は文字列です。 number: 数値タイプ boost_percentage: パーセンテージ (OpenSea Boosts) boost_number: 数値 (OpenSea Boosts) date: 日付タイプ (例: 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"
        }
      ]
    }
  }
}