Mintology API Overview

Here's a overview of the Mintology API, covering various endpoints and processes:

Authorization

1. Authorize:
   • Purpose: Validates the legitimacy of token ownership.
   • Parameters: Utilizes Mintology API Key and Project ID for validation.
   • Reference: Documentation Source.
2. List Authorized Tokens:
   • Purpose: This endpoint is used to get the list of tokens that a user owns from a particular collection.
   • Parameters: Utilizes Mintology API Key and Project ID for validation.
   • Reference: Documentation Source.

Projects Management

1. List Projects:
   • Action: Enumerates all created projects.
   • Reference: Documentation Source.
2. Create Projects:
   • Action: Generates a new project with designated details.
   • Reference: Documentation Source.
3. Retrieve Projects:
   • Action: Fetches project specifics identified by its Project ID.
   • Reference: Documentation Source.
4. Update Projects:
   • Action: Modifies a specific project with new details.
   • Reference: Documentation Source.
5. Remove Projects:
   • Action: Deletes a specified project from the platform.
   • Reference: Documentation Source.
6. Mint Config Update:
   • Action: This operation allows enabling or disabling minting (see mint endpoint). However, this can only be toggled after the project has been successfully deployed.
   • Reference: Documentation Source.
7. Claim Config Update:
   • Action: This operation allows enabling or disabling claiming (see claim endpoint). However, this can only be toggled after the project has been successfully deployed.
   • Reference: Documentation Source.
8. Deploy Projects:
   • Action: Launches a specified project for token minting.
   • Reference: Documentation Source.

Mintable Wallets

1. Create Mintable Wallet:
   • Action: Creates a new Mintable Wallet and Mintable account, enabling users to claim private key custody.
   • Reference: Documentation Source.
2. Request To Export:
   • Action: Commences the process for user custody claim of their Mintable Wallet.
   • Reference: Documentation Source.
3. Approve Export:
   • Action: Transmits the Mintable wallet private key to the user, necessitating a request_id and OTP for authorization.
   • Reference: Documentation Source.
4. Remove Mintable Wallet:
   • Action: Irrevocably deletes the private key from Mintology's systems post user custody claim of their Mintable Wallet.
   • Reference: Documentation Source.

Preminting NFTs

1. List Premints:
   • Action: Yields a list of premint items, arrayed by updated date with latest premints at the forefront.
   • Reference: Documentation Source.
2. Create Premints:
   • Action: Generates token details like name, image, animation_url, etc. for premint items.
   • Reference: Documentation Source.
3. Retrieve Premints:
   • Action: Fetches premint details like 'name', 'image', animation_url, etc. for specified premint items.
   • Reference: Documentation Source.
4. Remove Premints:
   • Action: Extinguishes a specified premint entity.
   • Reference: Documentation Source.
5. Import Premints:
   • Action: Import token details like name, image, animation_url and etc.
   • Reference: Documentation Source.

IMX (Immutable X) Endpoints

1. Register IMX User:
   • Action: Constructs an Immutable X layer 2 user account for an Ethereum layer 1 account.
   • Reference: Documentation Source​.
2. Mint IMX Item:
   • Action: Mints a distinct digital asset on an IMX blockchain, typically on the Ethereum network.
   • Reference: Documentation Source.
3. Transfer IMX Item:
   • Action: Transfers an NFT, sending ownership of the digital asset from one address on the IMX blockchain to another.
   • Reference: Documentation Source​.

Info Endpoints

1. Project Info:
   • Usage: Procures project information such as details and configuration.
   • Reference: Documentation Source​​.

Metadata Endpoints

1. Update NFT Metadata:
   • Usage: Alters NFT metadata encompassing details like token name, image, animation_url, etc., recommended to be invoked from the back-end.
   • Reference: Documentation Source.

Mint Endpoints

1. Mint:
   • Purpose: Facilitates the minting process of NFTs directly into a user's wallet.
   • Compatibility: Supports both custom Mintable Wallets and standard cryptocurrency wallets.
   • Reference: Documentation Source.

Claim Endpoints

1. Claim:
   • Purpose: Grants a complimentary NFT to the user's wallet.
   • Use Cases: Suitable for purposes like discount vouchers or proof of attendance tokens.
   • Reference: Documentation Source.