Get started with the API
Get Started with the NMKR Studio API
Use the API
Before you get started with the API you have to create your Authentication Token or API Key first in NMKR Studio. Depending on the network you are going to use, you need to create an API Key in either the testnet account, or the mainnet account.
The majority of requests will use some (or all of) the following elements:
- Base URI, Comprised of:
- Web Address
- API Version
- The Method Name
- Project UID
- NFT UID
- NFT Count
- JSON Payload
- Requestor IP address
- Other Specific Method Data
- API Key as a BEARER TOKEN in the Request Header You can run API calls from your computer using most popular languages but if you plan to allow users on your website to invoke them, you must ensure you set up your website using server frontend/backend principles. The reason for this is that most browsers will simply block any attempt to make an API call from the front-end UI (CORS Policy Error).
Note - the Project and NFT UID's are now both random strings that cannot be predicted, this extra security feature means that attackers cannot 'guess' the ID, making certain attacks more difficult even if the API Key is compromised.
Note - NEVER EXPOSE YOUR API KEY, IF YOU DO, DELETE IT AND MAKE A NEW ONE IMMEDIATELY.
curl -X 'GET' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxx'
Before you implement the API Endpoints into your DApp or website, you may want to test it out in the API Swagger. The API Swagger is available for the Mainnet as well as for the Testnet.
Another very useful tool to test API is Postman. Postman is an API platform for developers to design, build, test and iterate their APIs.
We also provide API Examples and Templates for the most common workarounds and features of the NMKR Studio API.