These guides will assist you in building from a 3rd party to our API, if you require support building the API a consultancy session can be purchased, please contact your CSM/AM to discuss and arrange. A custom API can connect with a 3rd Party Integration that Mintsoft currently doesn't support, the API must be built to Mintsoft.
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.
Note: By default, the API Key will expire after 24 hours. To make it static, please follow our set static API Key guide.
Authorising your API request
Each request must pass the API key in the header for other endpoints like below:
Example: Creating an order via PUT /api/Order.
Header name | Header value |
ms-apikey | 62e649a6-b48b-4e27-adbf-ebb0430451cc |
Note: This must be supplied as a Header not a Bearer Token.
Using Postman
If you are using Postman to connect to your Custom API, please ensure the Auth Type is set to No Auth within the Authorization tab.
API Articles
Please find below all our API-related articles:
General Configuration
Swagger - Lists all API Calls.