You can generate an API key to integrate Mintsoft with external systems. By default, API keys expire after 24 hours, but 3PL administrators and database administrators can set them to never expire. You'll need your Mintsoft password to generate the key.
Set your Mintsoft password
Before you generate an API key, you need to set your Mintsoft password. This may be different from your Access Evo password. Follow these steps to set it:
Click Settings, then click Change Password.
Enter the password you wish to use.
This password will be used to generate the API key.
Generate an API key
You can generate your API key from the Auth endpoint using your Mintsoft username and password. Follow these steps to generate it:
Warning: Your API key will expire after 24 hours unless you follow the steps in the Set a static API key section.
Go to /api/Auth.
Enter the request in the following format:
{
"Username": "Mintsoft username",
"Password": "login password"
}Click Try it out!
The response contains your API key.
Set a static API key
To extend the 24-hour expiry and set a static API key, follow these steps:
Important: Only 3PL administrators or database administrators can complete these steps.
Click Settings, then click either Warehouse User Accounts or Client User Accounts.
Search for the user that needs a static API key.
Click Actions, then click Set API Key to Never Expire.
Show the API Key column
If you can't see the API Key column on the account page, follow these steps:
Click the Column Visibility dropdown, located in the middle of the page.
Select the API Key option.
Click Apply.
The API Key column is now visible.
Note: Warehouse and Admin users can't view the API key of 3PL Client users. Client users must provide their API key to Warehouse users by following the steps in the Generate an API key section.
