FAQ - API
We collect all of the questions specific to the API of the NMKR Studio Web App from our community and compile the answers here

What is an API?

An Application Programming Interface (API) is a software intermediary that allows two applications to interact with each other. You can think about an API as an open set of methods that you can run by calling them over the internet.

How do I create an API key in NMKR Studio?

You can create a new APIKey in the "Manage API Keys" section which can be found in the navigation bar on the left of the dashboard, as illustrated in Step 1.
Manage API Keys

How do I call the API in Python?

You will need to use the Python requests library to make the related HTTP GET and HTTP POST method calls.

How do I utilise the /UploadNFT API (incl. metadata)?

You will need to use a programming language that has a library allowing you to make HTTP GET and HTTP POST method calls such as Python.
With the release of our SFTP Upload server this is not longer a requirement, but if you want to use the API to do this you can follow this youtube series (parts 8 and 9):
NFT Developer Diaries - Episode 8
Or read this guide on that exact topic.

How do I set up a vendor machine and use the /getaddress endpoints (select + random)

To do this, you will need to have a website and most importantly have access to the server side (backend). The reason for this is that most browsers will block any UI (front-end) attempts to make API calls from websites.
This implementation is reasonably complex and essentially requires you to code a website using the model-view-controller framework with something like:
  • REACT + Node.js
  • Python Flask + HTML + CSS
The good news is that you no longer NEED to do this since we released the Payment Gateway!
If you have a complex, custom solution in mind, then we encourage you to read through the Swagger UI guide for API calls first, in particular these methods:
  • GetAddressForRandomNftSale
  • GetAddressForSpecificNftSale
You will essentially need to have a UI front end element (like a button) that triggers a method to run on the server side. That method should make the HTTP GET call on one of those methods, handle the response in the backend and then present the data to the front end for the user.

Do I have to use the API to upload files to the service?

No, you can also use the interface to upload a file with subfiles attached, or the bulk upload option as demonstrated in Uploading Files.
In fact, you no longer need to use the API for ANY part of the set up process. You can use the Step-By-Step Guide for full details or simply follow this process for the fastest implementation.
  1. 4.
    Copy and Paste the Payment Gateway onto your website
  2. 5.
    Launch!
Copy link
On this page
What is an API?
How do I create an API key in NMKR Studio?
How do I call the API in Python?
How do I utilise the /UploadNFT API (incl. metadata)?
How do I set up a vendor machine and use the /getaddress endpoints (select + random)
Do I have to use the API to upload files to the service?