Zoom API OpenAPI Specification

June 19, 2017

“The Open API Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how REST APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving and promoting a vendor neutral description format. SmartBear Software is donating the Swagger Specification directly to the OAI as the basis of this Open Specification.

APIs form the connecting glue between modern applications. Nearly every application uses APIs to connect with corporate data sources, third party data services or other applications. Creating an open description format for API services that is vendor neutral, portable and open is critical to accelerating the vision of a truly connected world.”

- From https://www.openapis.org/

Zoom API

Zoom provides an OpenAPI (formerly known as swagger) specification for it’s API. By Zoom providing this document, developers are now able to take the specification and use it in one of many of the tools in the community and incorporate it into their development workflows.

Examples

Postman

One of the most popular REST API development tools out there is Postman. Postman supports importing an OpenAPI specification and creating collections to test out these APIs. You can import into the Postman client the Zoom API using the specification document hosted on GitHub: https://raw.githubusercontent.com/zoom/api/master/openapi.v2.json. As you can see in the example below the Create User method, along with all of the other methods in the specification, are imported into Postman and pre populated with all the available arguments. From here you can simply add your API key and secret giving you the ability to test out the Zoom API without writing any code.

Swagger Codegen

The Swagger Codegen is an open source code-generator to build server stubs and client SDKs directly from a OpenAPI defined RESTful API.

Using Swagger Codegen and the Zoom API OpenAPI specification you can easily generate a library for one of the many supported languages. The easiest way to do this is by using the online version of the swagger editor. Simply import from URL the Zoom OpenAPI specification and generate a client.

In the example above a PHP client library as created. After unzipping the directory you can see that documentation, a library, even unit testing files were created.

We believe that providing an OpenAPI specification for Zoom API will allow you develop faster and easier utilizing the tools and workflows that you have already become accustomed too. Please join us in our developer community and let us know any feedback you might have. Develop Happy!

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