QAF NFT
  • Getting Started
  • 📚TERMS/DOMAINS
    • Network
    • Project
    • Contract
    • Category
    • Nft Item
    • Nft Item Attribute
    • Project Token
    • Marketplace Fees
    • Marketplace Token
    • Marketplace Items
  • ⚙️API REFERENCE
    • Postman Collection
    • Authentication
    • NFT API
      • List Networks
      • Create Project
      • Get Project Detail
      • Filter Projects
      • Deploy Contract
      • Get Contract Detail
      • Filter Contracts
      • Add Category
      • Update Category
      • Delete Category
      • Get Category Detail
      • Filter Categories
      • Create Nft Item
      • Batch Create Nft Item
      • Validate Metadata File
      • Mint Nft Items
      • Update Nft Item Metadata
      • Set Nft Item Category
      • Get Nft Item Detail
      • Filter Nft Items
      • Add Nft Item Attribute
      • Update Nft Item Attribute
      • Delete Nft Item Attribute
      • Get Nft Item Attribute Detail
      • Filter Nft Item Attributes
      • Get Balance by Nft Item and Address
      • Get Balance by Address
      • Get Balance by Nft Item
      • Filter Nft Item Transfers
      • Deploy Project Token
      • Get Project Token Detail
      • Init Project Token Transfer
      • Client Token Transfer
      • Init Project Token Allowance
      • Check Project Token Allowance
      • Filter Project Tokens
      • Get Project Token Balance by Symbol and Address
      • Get Project Token Balance by Address
      • Get Project Token Balance by Symbol
      • Update Marketplace Royalty Fee
      • Filter Marketplace Fees
      • Add Marketplace Token
      • Get Marketplace Token Detail
      • Init Marketplace Token Allowance
      • Check Marketplace Token Allowance
      • Filter Marketplace Tokens
      • Init List Nft Item on Marketplace
      • Init Buy Nft Item from Marketplace
      • Init Cancel Listing from Marketplace
      • Get Marketplace Item Detail
      • Filter Marketplace Items
      • Init Transfer Nft Item
      • Init Transfer Nft Item to Client
      • Transfer Nft Item from Client
      • Init Lock Nft Item
      • Init Nft Approval Permission
      • Check Nft Item Approval Permission
      • Create Project Session
      • Get Project Session Detail
      • Filter Project Sessions
      • Create Off Chain Transaction
      • Get Off Chain Transaction
      • Filter Off Chain Transactions
      • Upload File
    • Error Codes
    • FAQ
      • How can I implement listing Nft Item on marketplace service properly?
      • How can I implement buy Nft Item from marketplace service properly?
Powered by GitBook
On this page
  • Validate Metadata File
  • Example Response Body
  • Excel File Format
  • Response Fields
  1. API REFERENCE
  2. NFT API

Validate Metadata File

Validate excel file content

PreviousBatch Create Nft ItemNextMint Nft Items

Last updated 2 years ago

The service accepts excel file which contains your Nft Metada informations and returns validated form of metadatas as JSON format. You can use the response data in the batch create nft item service.

Validate Metadata File

POST {{server-url}}/nft-items/file/validate

It returns the Nft item's identifier values.

Headers

Name
Type
Description

Authorization*

String

UUID formatted access token

Content-Type*

String

multipart/form-data

Request Body

Name
Type
Description

file*

File

Your metadata file

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}

Example Response Body

{
    "data": [
        {
            "contractType": "ERC721",
            "name": "r/place - 1",
            "description": "Reddit r/place 2022 Edition - 1",
            "url": "https://stagingnftgift.s3.eu-west-1.amazonaws.com/1649243914981",
            "totalSupply": 1,
            "categoryNameList": ["Yellow", "Green"],
            "attributes": [
                {
                    "traitType": "Color",
                    "value": "yellow",
                    "icon": "https://icons.io/colorpalette.png"
                }
            ]
        },
        {
            "contractType": "ERC721",
            "name": "r/place - 1",
            "description": "Reddit r/place 2022 Edition - 1",
            "url": "https://stagingnftgift.s3.eu-west-1.amazonaws.com/1649243914981",
            "totalSupply": 1,
            "categoryNameList": ["Yellow", "Green"],
            "attributes": [
                {
                    "traitType": "Color",
                    "value": "yellow",
                    "icon": "https://icons.io/colorpalette.png"
                }
            ]
        },
        {
            "contractType": "ERC721",
            "name": "r/place - 1",
            "description": "Reddit r/place 2022 Edition - 1",
            "url": "https://stagingnftgift.s3.eu-west-1.amazonaws.com/1649243914981",
            "totalSupply": 1,
            "categoryNameList": ["Yellow", "Green"],
            "attributes": [
                {
                    "traitType": "Color",
                    "value": "yellow",
                    "icon": "https://icons.io/colorpalette.png"
                }
            ]
        }
    ],
    "message": null,
    "code": 0,
    "error": false
}

Excel File Format

Column
Description

First Column - Contract Type

Represents which contract you will create Nft on. (It can be ERC721 or ERC1155 for this operation)

Second Column - Name

Represents Nft item's name

Third Column - Description

Represents Nft item's description

Fourth Column - Url

Represents Nft item's content url

Fifth Column - Total Supply

Represents count of Nft Item.

Sixth Column - Categories

Represents Nft Item's categories. We will expect of the name information of the categories. You should split the categories with |

Rest of columns - Attribute

Represents Nft Item's attributes. You can add multiple Attribute column. We expect specific format for the attribute column. You should split the informations with |

Response Fields

Key
Type
Description

contractType

String

Represents which contract you will create Nft on. (It can be ERC721 or ERC1155 for this operation)

name

String

Represents Nft item's name

description

String

Represents Nft item's description

url

String

Represents Nft item's content url

totalSupply

Number

Represents count of Nft Item.

categoryIdList

Array

Represents Nft Item's categories.

attributes.traitType

String

Represents attribute's name. You can not add already exist traitType.

attributes.value

String

Represents attribute's value

attributes.icon

String

Represents attribute's icon url.

⚙️
Example Excel File