{"id":21319464,"url":"https://github.com/zoom/zoom-oauth-sample-app","last_synced_at":"2025-04-05T10:09:13.042Z","repository":{"id":42080852,"uuid":"140465361","full_name":"zoom/zoom-oauth-sample-app","owner":"zoom","description":"Sample Zoom Oauth App NodeJS app to call Zoom's APIs","archived":false,"fork":false,"pushed_at":"2025-01-23T21:33:41.000Z","size":51,"stargazers_count":88,"open_issues_count":2,"forks_count":39,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-29T09:11:50.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zoom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-10T17:18:17.000Z","updated_at":"2025-01-23T21:33:44.000Z","dependencies_parsed_at":"2025-02-12T08:09:41.448Z","dependency_job_id":"72f739d1-2cac-4b93-a6fa-a5f79fe7635b","html_url":"https://github.com/zoom/zoom-oauth-sample-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fzoom-oauth-sample-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fzoom-oauth-sample-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fzoom-oauth-sample-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fzoom-oauth-sample-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoom","download_url":"https://codeload.github.com/zoom/zoom-oauth-sample-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318745,"owners_count":20919484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T19:42:00.849Z","updated_at":"2025-04-05T10:09:13.023Z","avatar_url":"https://github.com/zoom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zoom OAuth Hello World\n\nUse of this sample app is subject to our [Terms of Use](https://zoom.us/docs/en-us/zoom_api_license_and_tou.html)\n\nThis 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. \n\nFollow allong with relevant Zoom OAuth documentation as we set this up: \n\n1. [OAuth with Zoom](https://marketplace.zoom.us/docs/guides/authorization/oauth/oauth-with-zoom) \n2. [Create an OAuth App](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app) \n\n## Setup app locally\n\nClone 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. \n\n```bash\ngit clone https://github.com/zoom/zoom-oauth-sample-app.git\n```\n\n```bash\ncd zoom-oauth-sample-app \u0026\u0026 npm install \n```\n\nRun server:\n\n```bash\nnpm run start\n```\n\n### Setup dotenv \nCreate a `.env` file in which to store your PORT, access credentials, and Redirect URL.\n\n```bash\ntouch .env\n```\n\nCopy the following into this file, which we'll add your own values to:\n\n```\nCLIENT_ID=\nCLIENT_SECRET=\nREDIRECT_URL=\n```\n\n\u003e 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.\n\n## Install [ngrok](https://ngrok.com/)\n\nDuring 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.\n\nFor this we'll use [ngrok](https://ngrok.com/download), which creates a public link to a localhost development server.\n\nDownload and install ngrok, then follow the steps to connect your account.\n\nRun ngrok on the same localhost port (4000): \n\n```bash\n~/./ngrok http 4000\n```\n\nThis 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.\n\nExample: \n\n```\nREDIRECT_URL=https://12345678.ngrok.io\n```\n\n\n## Create an OAuth App on the Zoom App Marketplace\n\nSign in to the Zoom App Marketplace and [Create an OAuth App](https://marketplace.zoom.us/develop/create?source=devdocs). \n\nCreating this app will generate your OAuth Client ID and Secret needed to install on your account and get an access token. \n\nCopy these credentials and add them to your `.env` file.\n\nExample: \n\n```\nCLIENT_ID=1234567890\nCLIENT_SECRET=13245678901234567890\nREDIRECT_URL=https://12345678.ngrok.io\n```\n\n### Add your Redirect URL from ngrok to your app\n\nCopy and paste your ngrok link into the Redirect URL for OAuth field, then click Continue.\n\n### Fill out app information. \n\nTo install the app, we'll need to add some quick info on the app. Add in the following: \n\n1. *Short Description*\n2. *Long Description*\n3. *Developer Name*\n4. *Developer Contact*\n\n\n\u003e 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.\n\n### Add Scopes \n\nOAuth 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. \n\nTo 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.\n\n## Install app\n\nWith 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. \n\nClick **Install** or copy the Installation URL into a browser.\n\nZoom will now ask you to authorize the app on your account. Note that the app is requesting only the scope we've added.\n\n\u003e 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. \n\nAuthorizing the app will send you to the Redirect URL of your app, linked to our app running on localhost:4000.\n\nYour express server will log your access_token, refresh_token and the API call response to get your user information. \n\nIn 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. \n\n## Next steps \n\nFollow our documentation on OAuth with Zoom for more information on building a user-level app on the Zoom App Marketplace. \n\nCode happy!\n\n## Need help?\n\nIf 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fzoom-oauth-sample-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzoom%2Fzoom-oauth-sample-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fzoom-oauth-sample-app/lists"}