Postman
Postman is an excellent tool for exploring APIs from an easy-to-use desktop app.
Postman collections are a group of saved requests. Requests within a collection can be run with a common, inherited configuration that can be useful in accelerating exploration of the Baton API.
Download Postman here: https://www.postman.com/downloads/
Variable Substitution
Postman uses a handlebar style variable syntax. We make use of Postman Environment Templates to store different variables for each environment.
Create a New Collection from Baton’s Swagger file
In postman, click the
[Import]
button.Paste the url of Baton’s swagger file into the box. https://app.hellobaton.com/api/swagger.json Postman will automatically fetch and create a collection.
On the next screen, you can choose how to import. Make your selection and click
[Import]
Click into the Baton Api collection and start configuration.
Navigate to the Authorization tab.
Now that your collection is configured, you can navigate to any request in the collection to explore! We recommend unchecking the page
and page_size
query params to start your exploration.