Swagger Setup
Swagger is built into Neo 2.1 and can be accessed by adding "/swagger" to the end of your API URL, like so: https://localhost/api/swagger
If you would like to use Swagger to test API method calls, you will need a valid authorization token. Once you have the token you need to put in the text box at the top of the Swagger page labeled "api_key". You will need to put the word "Bearer " (note the space after) followed by the API key.
If you do not use the word "Bearer " with a trailing space, the API call will fail with a 'not authorized' error because the key wasn't found.
Postman Setup
Setting up Postman is a little more involved than using Swagger but Postman also has some nice features that can't be performed with Swagger.
The first setup is to download and install Postman.
With Postman successfully installed, you can now import the attached collection file to this article which has many API calls set up and ready to be called.
To import, open Postman and select 'Import' from the menu at the top:
Find the file you downloaded from this article and import that file to Postman.
Next, you need to import an 'Environment' in Postman and configure a few items for the Environment. There is an attached environment file that can be used that has all of the basic variables you would need. In the upper, right corner of Postman, click the gear icon, below the upgrade button:
Click the "Import" button and find the file you downloaded from this article and import that file to Postman.
Edit the newly added "ManutouAPI" environment by clicking on the name.
Note: If you wish to create your own environment click the "Add" button and give your new Environment a name.
In the area below the name, you will need to add 8 variables and initial values (set "current value" to the same as "initial value"):
- New variable name: url
- Value: This is the base URL for your API server.
- Correct Path: https://localhost
- Example: https://qadanzig.boldgroup.com
- Note: https://localhost/api or https://qadanzig.boldgroup.com/ would not be correct
- New variable name: token
- Value: If you have a token you can use it here. If you do not have a token you can leave blank, and run an OAUTH request.
- New variable name: boldUsername
- Value: this will be the user name of your Bold Net user.
- New variable name: boldPassword
- Value: this will be the password of your Bold Net user.
- New variable name: manitouName
- Value: this will be the user name of your manitouNEO user.
- New variable name: manitouPassword
- Value: this will be the password of your manitouNEO user.
- New variable name: workstationName
- Value: this will be the name of the computer you are logging in from.
- New variable name: workstationId
- Value: this will be the workstation ID of the computer you are logging in from.
To find the Workstation ID and Workstation Name: Navigate to manitouNEO and login, once you have done that you can find the workstation ID and Name in the SWS under Maintenance > Workstations
Press "Update" and then close the "Manage Environments" window.
Select your new environment within the dropdown menu.
If you supplied a valid token in the Environment, then you are ready to start making API calls.
To generate a new token, find the "OAUTH Request" call in the list and press the blue "Send" button, the result will look like this
The token generated by running "OAUTH Request" is automatically stored in the Environment token variable.
Now you have a stored token and are ready to use it to make other API calls.
