https://github.com/zoom/zoom-oauth-sample-app
Sample Zoom Oauth App NodeJS app to call Zoom's APIs
https://github.com/zoom/zoom-oauth-sample-app
Last synced: 11 months ago
JSON representation
Sample Zoom Oauth App NodeJS app to call Zoom's APIs
- Host: GitHub
- URL: https://github.com/zoom/zoom-oauth-sample-app
- Owner: zoom
- License: other
- Created: 2018-07-10T17:18:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-23T21:33:41.000Z (about 1 year ago)
- Last Synced: 2025-03-29T09:11:50.963Z (11 months ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 88
- Watchers: 15
- Forks: 39
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Zoom OAuth Hello World
Use of this sample app is subject to our [Terms of Use](https://zoom.us/docs/en-us/zoom_api_license_and_tou.html)
This is a Hello World app using an OAuth Marketplace App client ID and Secret to create an OAuth token, used to call the Zoom API.
Follow allong with relevant Zoom OAuth documentation as we set this up:
1. [OAuth with Zoom](https://marketplace.zoom.us/docs/guides/authorization/oauth/oauth-with-zoom)
2. [Create an OAuth App](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app)
## Setup app locally
Clone and install the app and it's dependencies. We'll be using [Express](https://www.npmjs.com/package/express) for a basic Node.js server, [dotenv](https://www.npmjs.com/package/dotenv) for our credentials, [requests](https://www.npmjs.com/package/requests) to make HTTP requests and [nodemon](https://www.npmjs.com/package/nodemon) for easier development refreshing.
```bash
git clone https://github.com/zoom/zoom-oauth-sample-app.git
```
```bash
cd zoom-oauth-sample-app && npm install
```
Run server:
```bash
npm run start
```
### Setup dotenv
Create a `.env` file in which to store your PORT, access credentials, and Redirect URL.
```bash
touch .env
```
Copy the following into this file, which we'll add your own values to:
```
CLIENT_ID=
CLIENT_SECRET=
REDIRECT_URL=
```
> Remember: Never share or store your client credentials publicly. Your `.env` is included in the `.gitignore` file to ensure these files won't be included in a git workflow.
## Install [ngrok](https://ngrok.com/)
During the OAuth flow, Zoom will need to know where to redirect a user after they have successfully authenticated and installed the app on their account.
For this we'll use [ngrok](https://ngrok.com/download), which creates a public link to a localhost development server.
Download and install ngrok, then follow the steps to connect your account.
Run ngrok on the same localhost port (4000):
```bash
~/./ngrok http 4000
```
This will generate a forwarding link. Copy this and add it into your `.env` file as the `REDIRECT_URL`. Keep ngrok running! If the linkage disconnects, we'll need to readd a new REDIRECT_URL.
Example:
```
REDIRECT_URL=https://12345678.ngrok.io
```
## Create an OAuth App on the Zoom App Marketplace
Sign in to the Zoom App Marketplace and [Create an OAuth App](https://marketplace.zoom.us/develop/create?source=devdocs).
Creating this app will generate your OAuth Client ID and Secret needed to install on your account and get an access token.
Copy these credentials and add them to your `.env` file.
Example:
```
CLIENT_ID=1234567890
CLIENT_SECRET=13245678901234567890
REDIRECT_URL=https://12345678.ngrok.io
```
### Add your Redirect URL from ngrok to your app
Copy and paste your ngrok link into the Redirect URL for OAuth field, then click Continue.
### Fill out app information.
To install the app, we'll need to add some quick info on the app. Add in the following:
1. *Short Description*
2. *Long Description*
3. *Developer Name*
4. *Developer Contact*
> We won't need to add any Features to our app, but if we wanted to enable [Event Subscriptions](https://marketplace.zoom.us/docs/guides/tools-resources/webhooks#event-subscriptions) through Zoom Webhooks, we'd do it here.
### Add Scopes
OAuth is used to guarantee that an app only has access to the data you authorize. If an app does not have the required scope, it cannot call the API on your behalf.
To request data,we'll need to add a Scope to our app. The only data we need is for a user's profile information. Click **+ Add Scopes** and add *"View your user information"* (`user:read`). Click **Done** and continue on to the Installation page.
## Install app
With our app running on `localhost:4000`, a live REDIRECT_URL from ngrok, and proper scopes requested we can now install the app on our account.
Click **Install** or copy the Installation URL into a browser.
Zoom will now ask you to authorize the app on your account. Note that the app is requesting only the scope we've added.
> If you're not the admin on your Zoom account, the admin might require you to ask them for pre-approval to install this app. Submit a request to get this pre-approved by your account admin.
Authorizing the app will send you to the Redirect URL of your app, linked to our app running on localhost:4000.
Your express server will log your access_token, refresh_token and the API call response to get your user information.
In your browser, you'll see your Zoom profile data, with a JSON object showing the response. This API request was made using an `access_token` specific to this app and scopes.
## Next steps
Follow our documentation on OAuth with Zoom for more information on building a user-level app on the Zoom App Marketplace.
Code happy!
## Need help?
If you're looking for help, try [Developer Support](https://devsupport.zoom.us) or our [Developer Forum](https://devforum.zoom.us). Priority support is also available with [Premier Developer Support](https://zoom.us/docs/en-us/developer-support-plans.html) plans.