Set up Postman
By the end of this article, you'll have the Postman client up-and-running, where you can explore Faria APis.
1. Download Postman
Postman is the software of choice by professionals. Of course, any API client can be used with APIs, but Postman is the most complete in terms of feature sets.
2. Import the Reference Documentation
In Postman, create a Workspace. Then use the "Import" button and paste in the json link which can be found below:
We have set up a Collection which contains all of the available endpoints. It also has its variables set up for the following:
Encourages use of environment variables
Commonly used IDs, such as
studentIdcan be set once and used throughout
Go to "Import' and paste one of the following links:
3. Set up the Variables
To work as intended, the variables needs to be set accordingly:
You'll notice that some of the variable names start with env-. These are intended to be defined as an Environment variable. Using Environment variables helps ensure your tokens are separated from the collection.
An Environment and Environment variables can be created on the far right side of the screen:
Saving changes on the below screen can be confusing. At the time of writing, it requires a two-step action of clicking on "Persist All" and then saving.
Last updated
Was this helpful?