In order to generate a Test API User, you will first need to create a user in Test Mode. Test Mode enables a user to access the MachShip's sand-boxed testing environment. This will access live quoting but will not push out any data to transport providers.
How to Create a User in Test Mode
To set a user in Test Mode, navigate to Admin and select Create User
You would set up your user as you would be configuring a standard user. This would require at a minimum
To understand the above in more detail simply refer to the article on how to create users linked here
To set the user into Test Mode:
Scroll down to Test mode and select User is in test mode
Select Save User
The user will now be in Test Mode.
To validate that a user is in test mode you will see the below banner when you login to MachShip:
Generate a valid API token
Firstly, you need to access the created user in the View Users page:
If you are unable to see the User, MachShip has provided two ways to search for them:
- Company filter - Once you start typing a company's name, MachShip will present a list of options. Select the relevant option from this list.
- General Search - When entering any keywords in this section, MachShip will filter through the list of users and bring up ones that have those keywords.
Once you have found your user simply click on the cog and choose View User.
On the View User screen, please scroll down to the bottom until you see this section:
This sample screenshot shows that there is no API Token for the user yet. To create one, please click on Create Api Token button. It will pop up a dialog like the below image.
You will need to type in a Token Name. Note that it needs to be unique as it will be a way for MachShip to identify and show up in the history logs.
Click on Create Token button to generate the API Token.
If you see the sample error message from the below screenshot, it means the name is already taken and that you will need to enter another name.
When the token is generated successfully, you will see a screen similar to the below:
You can copy the Token by highlighting the text field and press ctrl + C buttons or click on the blue copy icon button to automatically copy the token.
Note: You will need to note down the generated API Token and store the token value for safekeeping as its Read Only and you will not be able to view the Token value again, else, you will need to re-generate a new API Token.
Once copied, you are ready to connect to the MachShip API.