Customers receiving the following error (The user is using a deprecated API Authentication method. Please refer to the Help Guides for API Authentication before this is deactivated and impacts connectivity) please review this help guide.
Please be advised that our API authentication method has changed as part of an update to our security policies.
If you have any 3rd party integrations using the public API, please advise them that they will need to ensure the update has been applied before 1st May 2024. These changes do not apply to Courier Developer Portal integrations.
The change implemented has removed API key details from the URL and moved them into the body of the call.
Authentication – Now a POST endpoint where the username and password are sent in the body of the call
Authorisation – The API Key is now passed in via the header.
Obtaining an API Key
To get an API key please complete these steps -
Go to the following Swagger link: https://api.mintsoft.co.uk/swagger/ui/index#!/Auth/Auth_Post
Enter the request in the following format -
{ "Username": "Mintsoft username", "Password": "login 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.
Authorising your API request
Each request needs to pass the API key in the header for other endpoints.
Example: Creating an order via GET /api/Order/{id}
Header name | Header value |
ms-apikey | 62e649a6-b48b-4e27-adbf-ebb0430451cc |
Note: Please unsure you are using the most recent version of the Mintsoft app and courier print tool.