Using Zoom APIs Version 1 with Postman

July 20, 2017

Postman is the most complete toolchain for API development and testing. It's many features like importing collections and setting up environments makes 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.

First make sure you have the latest version of Postman, as of this post it is v5.1.1

Import the Zoom API collection from GitHub using the OpenAPI specification. In the top toolbar click "Import" then select "Import From Link". Enter in the path to the spec from GitHub https://raw.githubusercontent.com/zoom/api-v1/master/openapi.v2.json and click "Import"

You should now have all of the APIs listed in your Postman tool under a collection called "Zoom API"

From here you can begin testing all of the Zoom APIs, however let's make it a little easier. If you inspect one of the endpoints, in this example "/v1/user/list", you'll notice in the Body parameters tab that all of the parameters are displayed with some of the default values pre-populated. You'll also notice that some of the parameters have been populated with a variable, ex. "{{api_key}}".

Now you could go through and for every endpoint replace these with your API Key and Secret, or we can take advantage of Environments in Postman. Let's add an Environment!

Click the gear icon in the top right and then click "Manage Environments"

Next, click "Add" to create a new environment. You can name the environment whatever you like, in this example we kept it simple and named it "Zoom". We then added a couple key/value pairs, api_key and api_secret. You could create values for all the possible values in the API, however we are only added these for now. Click "Add" to save your environment setup, then close the dialog to return to the Postman tool.

Now in the top right you will see a dropdown that is currently set to "No Environment". Select your newly created environment from the dropdown. You will see those variables available in your setup turn from red to orange. You can hover over a variable to see it's value.

This API endpoint doesn't have any other required parameters so you should now be able to click send and test it out.

Instead of changing out the api_key and api_secret everywhere you are now able to use the power of Postman and environments and have the value set for all endpoints and can easily start testing out the Zoom APIs.

If you have any questions reach out to us in the community

 

Develop Happy!

Joshua Woodward
Joshua is Developer Advocate at Zoom, helping developers add Video, Voice and Screen Sharing into their applications.