Prerequisite - Generating a Mintsoft Password
When generating an API Key using the steps below, please ensure you are entering your Mintsoft Password (This may be different from your Access Evo password). To set a Mintsoft password, please follow the steps below:
In Mintsoft click Settings then Change Password.
Enter the password you wish to use.
This password will be used to generate the API Key.
Obtaining an API Key
To get an API key please complete these steps:
Click the following link: /api/Auth.
Enter the request in the following format -
{ "Username": "Mintsoft username", "Password": "Mintsoft password" }Click Try it out!
The response will contain the API key.
Your API key will have a 24-hour expiry on it.
Setting a static API Key
These next steps need to be completed by the 3PL/ Admin of the database. To extend the 24-hour expiry and set a static API Key, please do the following:
Go to Settings then either Warehouse User Accounts or Client User Accounts.
Search for the user that needs a static API Key.
Click Actions then Set API Key to Never Expire.
If you cannot see the API Key column on the account page, please click on the Column Visibility dropdown in the middle of the page and add it from there. To help identify if an API Key is static or not can be determined by the Year listed in the LastAPIKeyGenerated column, if the year is higher than the current year this will be a static key and the date listed in the column will be the day the key expires. Please be aware that Warehouse and Admin Users are unable to view the API Key of 3PL Client Users. It is the responsibility of the Client User to provide this API Key to the Warehouse User by following the instructions in the Obtaining an API Key section above.