NMKR Docs
ProductsContact
English
English
  • Welcome to NMKR Docs
  • Introduction
    • About NMKR
    • Powered by NMKR
    • What is an NFT?
      • What is IPFS?
    • Why Cardano?
  • NMKR Studio
    • Introduction - NMKR Studio
    • Features Overview
    • 🖥️Learn NMKR Studio in 3 minutes
      • Basic Workflow
    • How to - Quick Start Tutorials
      • Quickstart Full Video Tutorial
      • Guidelines Planning a Project
      • How To Add Tokens
      • How to set up Metadata
      • How To Sell Tokens
      • How To Set Up Sales Conditions
      • How To Do a Reveal
      • How To Burn Tokens
      • How To Enable Royalties
      • How To Enable DIDs
      • How To Set up Whitelisting
      • How to Airdrop Tokens
    • Pricing
    • Account
      • Registration & KYC
      • Security
      • Wallets
      • Mint Coupons
      • Dashboard
      • Transactions
      • Invoices
      • API Keys
    • Project
      • Policy
        • Managing policies
      • Create
      • Edit
      • Metadata Template
      • Statistics
      • DID - Decentralized Identifier
      • Notifications
      • Royalties
      • Additional Payout Wallets
      • Affiliate links
      • Export Metadata as Zip
      • Export NFT as csv
      • Mint and Send Jobs
      • Export placeholder.csv
    • Token
      • Manage Tokens Tab
      • Upload
        • Upload single tokens
        • Bulk Upload Files and Metadata
          • Bulk Upload via Drag and Drop
          • Bulk upload via SFTP
      • Edit
      • Metadata
        • Add Token-specific Metadata
        • Fingerprint (Metadata preview)
        • Metadata Check
        • Metadata Standard for fungible Tokens
        • Fully on-Chain NFTs
          • Partial URL-Encoding
        • CIP-68
      • Duplicate
      • Delete
      • Burn
      • Update (Edit after Mint / Reveal)
    • Set up Sales
      • Manage prices / Pricelist
        • Create new Prices
        • Free Drops
        • Custom Token payment
        • Discounts
      • Sales Conditions & Whitelisting
        • Sales conditions depending on policy ID or stake pool
        • Whitelist with Count
        • Blacklist
        • Test Sales Condition
      • Block Tokens
      • NMKR Pay
        • Set up NMKR Pay
        • MultiSig Payment
        • Website Integration
        • Specific Payment Links
        • Manual sending in NMKR Pay
        • FIAT ETH and SOL Payment
      • Pay-In Address
      • Auction
    • Minting
      • Minting on Demand
      • Manual Minting
      • Airdropper
        • Airdrop with random distribution
        • Airdrop with specific distribution
    • Tools
      • Managed Wallets
      • Split Addresses
      • Direct Sales
      • Policy Snapshot
      • Integrations & Plugins
        • NFT Pal
        • Zapier
    • Testnet
      • Create Testnet Account
      • Testnet Wallet & tADA
      • Testnet API Swagger
  • NMKR Studio API
    • Introduction - NMKR Studio API
    • API Features
    • Swagger API Endpoints
    • Get started with the API
    • API Swagger
      • Get Started with the Swagger
      • Swagger Responses and Error Codes
    • API Examples
      • Users
        • Payout Wallets
        • Subcustomers
      • Project
        • Create Project
        • Upload File and Metadata
      • Payment
        • Create unique NMKR Pay Link for random Token sales
        • Create NMKR Pay Link for specific Token sales
        • Get Payment Address for single NFT sales with native Tokens
        • Create NMKR Pay Link for a multi-specific Tokens sale
      • Minting
        • Manual Minting
      • Smart Contract
        • Secondary Sales via NMKR Pay
    • API Open Source Contributions
  • NMKR Mint
    • Introduction - NMKR Mint
    • Mint single NFTs
    • Mint Collection
  • NMKR Playground
    • Introduction - NMKR Playground
    • ADA Payment Link
    • Paperwallet
  • NMKR Pool
    • What is Staking?
    • Stake with NMKR Pool
  • Helpful Links
    • Cardano NFT Ressources
    • Cardano Resources
    • Cardano Wallets
    • Open Source Repositories
    • Security Practices
    • Deal with Bots
Powered by GitBook
On this page
  • Manage your API Keys
  • Create API Key
  • Note the Key
  • Editing Settings
  • Restrict by IP
  • Revoke the API Key
  1. NMKR Studio
  2. Account

API Keys

Create API Keys to utilize the NMKR API and control the permissions for each Key individually

PreviousInvoicesNextProject

Manage your API Keys

To grant or restrict access to specific services, we use a key-based authentication approach with our API. On the Manage API Keys page, you can create new keys, set their rights and expiration dates, and restrict IP access.

In NMKR Studio, you can generate an infinite number of API keys.

Note - NEVER share your API Keys ANYWHERE

Create API Key

The first thing you need to do, is create your API Keys, this is a very simple process. Start by navigating to the 'Manage API Keys' Section.

Next, click on "create new API Key".

We should now see a new screen which allows us to perform the initial set up of our API Keys.

Note - You can make, create and delete as many Keys as you like, there is no limitation. But for safety reasons, please delete the keys that you don't need anymore.

Also note the expiry date is within a reasonable timeframe (the default is probably good enough). Once you are happy, select 'Create Apikey'.

Note the Key

Once created, you get one chance to make a note of the API Key. This is the most important part, so make a note of this and keep it very safe.

Note - Anyone who has this API key can use the active features - DO NOT SHARE IT

Editing Settings

You will now find each created API key on your overview.

Selecting the edit button will allow you to change the name and expiry date of your API Key.

Restrict by IP

Following on from above, selecting the alarm clock icon will allow you to further lock down who can use the API Key, based on their IP address. This menu allows you to manage this via combinations of Allow/Deny Rules.

Note - the default is set to 'Allow all' which will be sufficient if you ensure that your API Key is kept safe.

If you ever have reason to believe your API Key is compromised, we would recommend deleting it as mentioned above and generating a new one.

Revoke the API Key

Please click the button to remove an API Key's permissions once it is no longer required.

This is particularly important if you intend to make API calls based on actions on your website, please see our for more details.

For more information about how to use the API please check out the . Or the .

Security Practises
API documentation here
Testnet API Documentation here
Manage API Key permission individually for each API Key
Edit your API Keys name and expiration date after the creation
Set up individual access rules for IPs
Revoke API Key