API Overview

This page provides an overview of the API endpoints for the NFT Platform API.

Integration

All API endpoints require authentication using API keys. You can generate API keys in the API Key Management section.

Generate API key via GUI

You can generate API keys from the NFT Platform app, check out Generate API keys from the NFT Platform App section.

To use the API endpoints, you need to make authenticated requests with your API key in the api-key header.

curl

curl -X POST \
  https://nft-platform.azurewebsites.net/api/v1/endpoint \
  -H 'Content-Type: application/json' \
  -H 'api-key: your-api-key-here' \
  -d '{...}'

http

POST https://nft-platform.azurewebsites.net/api/v1/endpoint HTTP/1.1
api-key: your-api-key-here
Content-Type: application/json
{...}

fetch

await fetch('https://nft-platform.azurewebsites.net/api/v1/endpoint', {
  method: 'POST',
  headers: {
    'api-key': 'your-api-key-here',
  },
  // ...
});

axios

await axios.post('https://nft-platform.azurewebsites.net/api/v1/endpoint', {...}, {
  headers: {
    'api-key': 'your-api-key-here',
  },
});

Generating API key from the NFT Platform

1. Log into the NFT Platform App.
2. Navigate to Settings in the bottom navigation bar.
3. Click on the API Keys tab from side menu.
4. Click Create API button.

5. Copy your API key and store it securely.

CAUTION!

Maintain the confidentiality of your API key by keeping it private. If it is compromised, promptly delete the key and create a new one.

Endpoints

The following endpoints are available:

API Key Management

• GET /api-key/user/:userId - Retrieve a list of API keys for a specific user
• GET /api-key/:apiKeyId - Retrieve a specific API key by ID
• GET /api-key/my - Retrieve a list of API keys for the authenticated user
• GET /api-key/my/organization - Retrieve a list of API keys for the authenticated user's organization
• POST /api-key - Create a new API key
• DELETE /api-key/:apiKeyId - Delete a specific API key by ID

API Key Metrics

• GET /api-key-metrics - Get Users API key metrics
• GET /api-key-metrics/:apiKeyId - Get API key metrics by API key ID

User Management

• POST /users/signup - Sign up a new user.
• POST /users/signupLocalUser - Sign up a new local user.
• GET /users - Retrieve all users.
• GET /users/:userId - Retrieve a specific user by ID.
• PUT /users/:userId - Update a specific user by ID.
• DELETE /users/:userId - Delete a specific user by ID.
• GET /users/profile - Retrieve the profile of the authenticated user.

Collection Management

• POST /collection - Create a new collection
• GET /collection - Get all collections
• GET /collection/user - Get user collections
• GET /collection/categories - Get collection categories
• GET /collection/:id - Get a collection by ID

NFT Management

• GET /nft/ - Get all NFTs
• POST /nft/ - Mint new NFTs
• PATCH /nft/ - Claim an NFT
• PUT /nft/assign - Assign NFT to user
• GET /nft/user - Get user's NFTs
• PATCH /nft/collections/:collectionId/tokens/:tokenId - Transfer NFT
• POST /nft/create-assign - Create and assign NFT
• POST /nft/batch-mint - Batch mint NFTs
• POST /nft/batch-mint-assign - Batch mint and assign NFTs
• GET /nft/:collectionId/:tokenId - Get NFT by token ID

Permissions

Each endpoint has a set of permissions that are required to access it. Only users with the required permissions can access the endpoint.