What is Postman?
Postman is a complete toolchain for API development and testing. Its many features such as importing collections and setting up environments make it easy to get started with testing a third party API. In this post we will walk through the fastest way to setup and play around with Zoom’s APIs in Postman.
To get started you will need to import the Zoom API collection from GitHub using the OpenAPI Specification. In the top toolbar click Import, then select Import From Link. In the pop-up box enter the following link and click import Import.
Enter this link:
You should now have all of the APIs listed in your Postman tool under a collection called Zoom API.
Zoom API Version 2 utilizes JSON Web Tokens (JWT) for authentication. To use Postman with the Zoom API, we need to provide a JWT. The easiest way to do this is to go to jwt.io and create one.
(You will first need to go to your developer account page and get your API key/Secret to generate the token).
Build your JWT on the jwt.io by populating the Decoded section with the following. Replace the
<API_SECRET> with your information, and set the expiration time (
exp) in the payload to a future time. In your Production implementation, we recommend setting the
exp to something short like 60 seconds.
When testing, having to update your token every minute could become bothersome. In this case please set your expiration time to a time that is more appropriate such as seven days. This span of time is how often you will have to update Postman with new credentials.
After you have your JSON web token, go back to Postman and edit the Zoom API collection.
On the Edit Collection screen, switch over to the Authorization tab. Change the type to Bearer Token and paste your JWT into the text area on the left. Click Update.
Now let’s take a look at an API endpoint: List Users. In the Authorization tab, you should see that the Type is set to “Inherit auth from parent.” The message in the box on the right side of the screen should indicate that the request is using the helper we just set up. Try clicking Send.
You should get a successful response. If you switch over to the Headers tab, you will see that the Authorization Header was automatically added to the request.
These steps should get you started quickly testing out the Zoom API with Postman. For more tips such as setting up environment variables, please refer to the post on Using Zoom API Version 1 with Postman.