Open the Postman app and click the
Import button in the top left.
Link tab and paste the URL to the Detection on Demand API yaml file. Click
Continue, and the collection will be created for you.
You can find the link to the yaml file by navigating to the DoD API and copying the URL to the yaml file.
In order to make a request, you will need to insert your API key and review the parameters that will be sent along with the request. Let's see an example of how to submit a file.
Start by right clicking the
Detection on Demand collection and selecting
Edit from the dropdown.
Click on the
Authorization tab and paste your API key into the
Value field. Click
Update to finish.
Next, click on the
Detection on Demand collection and then clicking on the first
Submit a single file for analysis.
Next, navigate to the
Body tab. The
file parameter is required. You can change the type of
file from string to file by clicking on the
file key, clicking on the
Text dropdown, and clicking the
Now you can select a file from your computer to submit to DoD. Click on the
Select Files button in the
Value field, and select a file from your computer.
The rest of the parameters are optional. For this demonstration, you will uncheck all of the other parameters so they aren't sent to DoD.
Send button, and you should be greeted with a successfull response in the pane below. Now you can start exploring the other endpoints!