Niftory Docs
  • What is Niftory?
  • Get your API Keys
  • 👩‍💻API
    • Niftory Web3 API
    • SDK QuickStart
      • Using the SDK in React
      • Using the SDK from the Server
    • API Quickstart
      • Create your first Wallet
      • API calls with Sample Content
      • Mint your first NFT
    • API Cheat Sheet
    • Niftory Sample App
      • Explore the Sample App
      • Anatomy of a Niftory App
        • Getting Authenticated
        • GraphQL Client Setup
        • API Usage
        • Transfer an NFT
    • 💡Core Concepts
      • Niftory Data Model
      • Authentication
        • Using Your API Key
        • Configuring Your App
        • Privileged Authentication
      • App and AppUser
      • NFTs
        • Creating NFTs
        • Querying NFTs
        • Transferring NFTs
        • Minting NFTs
      • Wallets
        • Create a Niftory Wallet
        • Register External Wallets
        • Query Wallets
      • Contract
      • User Auth (Client-Side)
    • Your Niftory Account
  • 🧑‍💼Admin Portal
    • Niftory Admin Portal
    • 🚀Guides
      • Setting Up Your Org
      • Create Your First NFT
    • 🗺️Explore
      • Org and Apps
      • NFT Collection
        • Sets
        • Collectibles
        • NFTs
    • 💼Use Cases
      • For Engineers
      • For Designers
      • For Business Users
  • 📖Reference
    • GraphQL & Auth Endpoints
    • API Reference
    • SDK API Reference
Powered by GitBook
On this page
  • Why start with GraphQL?
  • Niftory Data Model
  • API Endpoints
  • Authentication
  • APIs at a Glance

Was this helpful?

  1. API

API Cheat Sheet

PreviousMint your first NFTNextNiftory Sample App

Last updated 1 year ago

Was this helpful?

The Niftory API is built in . We also plan to support endpoints in the future. Our GraphQL Endpoint can be found here:

Why start with GraphQL?

GraphQL has become a well-established standard for , giving the power of what to query and how much to query to the app developer (with strong typing!). This is consistent with of making it as easy as possible for you to quickly launch high-performing experiences.

If you have a strong need for REST endpoints for your application, please .

Niftory Data Model

Here are the core concepts in the Niftory data model.

For more details, see the Data Model guide

API Endpoints

Always test your application against the Staging environment. The production endpoint will affect the blockchain for real, so that should only be used when you are ready to ship your app.

https://graphql.api.staging.niftory.com

Production (targets blockchain prod)

https://graphql.api.niftory.com

Authentication

More details in the Authentication guide:

APIs at a Glance

An NFTSet is a bag of NFTModels

An NFTModel is a bag ofNFTs

An NFT is the thing that a user actually owns.

Happy Coding!

Remember to to set up your application!

  • Representation of your application in Niftory ecosystem.

  • Queries:

  • Queries:

Your application needs to registerWallet --> verifyWallet --> readyWallet for any given user in order to set up the wallet to receive NFTs. .

  • Queries:

  • Mutations:

A blueprint for an NFT, containing everything needed to mint one -- file content, blockchain metadata, etc.

  • Queries:

  • Mutations:

  • A bag of NFTModels, to help you organize your NFTs

  • Queries:

  • Mutations:

You can also use the Admin Portal to NFTSets and NFTModels for your application.

- returns the current App context.

Representation of a user logged in to your application via Niftory's .

- returns the currently logged-in AppUser context.

Representation of a user's blockchain wallet scoped to your application. For more information, see .

:

- returns the currently logged-in user's Wallet.

:

- creates a custodial Niftory wallet

- registers the given wallet address to the currently logged-in user.

- verifies that the user actually owns the Wallet by asking them to sign a secret.

- marks a Wallet as ready for usage for the application.

A representation of an (it doesn't have to be minted yet).

- returns all NFTs belonging to the currently logged-in AppUser.

- returns an NFT by its Niftory database ID.

- initiates the transfer of a specified NFT to a specified user. This API may mint the NFT if it isn't yet minted.

- returns the NFTModels belonging to the current App context.

- returns an NFTModel by its Niftory database ID.\

/ - creates/updates an NFTModel

- returns the NFTSets belonging to the current App context.

- returns an NFTSet by its Niftory database ID.

/ - creates/updates an NFTSet

👩‍💻
get your API keys
Authentication
💡
See Niftory API Reference here
app
authentication service
appUser
Wallet
Wallet Setup
wallet
createNiftoryWallet
registerWallet
verifyWallet
readyWallet
Read more here
NFT
nfts
nft
transfer
nftModels
nftModel
createNFTModel
updateNFTModel
sets
set
createNFTSet
updateNFTSet
create and manage
GraphQL
REST
GraphQL & Auth Endpoints
building performant web applications
reach out to us
Queries
Mutations
App
AppUser
our philosophy
NFT
NFTModel
NFTSet