You can build a custom API to connect Mintsoft with third-party integrations that aren't currently supported. These guides will assist you in building from a third party to our API. If you require support building the API, a consultancy session can be purchased. Please contact your Customer Success Manager or Account Manager to discuss and arrange.
Important: The custom API must be built to Mintsoft.
Prerequisite - Generating a Mintsoft password
Before you generate an API key, you need to set a Mintsoft password. This may be different from your Access Evo password.
To set a Mintsoft password:
In Mintsoft, click Settings, then click 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": "login password"
}3. Click Try it out!
4. The response will contain the API key.
Note: By default, the API Key will expire after 24 hours. To make it static, please follow our set static API Key guide.
Authorise your API request
Each request must pass the API key in the header for other endpoints.
Example: Creating an order via PUT /api/Order.
Header name | Header value |
ms-apikey | 62e649a6-b48b-4e27-adbf-ebb0430451cc |
Important: This must be supplied as a Header not a Bearer Token.
Using Postman
If you are using Postman to connect to your custom API, ensure the Auth Type is set to No Auth within the Authorization tab.
API articles
You can find all our API-related articles below:
General Configuration
Swagger - Lists all API calls