Skip to content

Latest commit

 

History

History
133 lines (85 loc) · 5.79 KB

README.md

File metadata and controls

133 lines (85 loc) · 5.79 KB
Raw

Zoom Meeting SDK Auth Endpoint sample

Use of this sample app is subject to our Terms of Use.

This is a Node.js / Express server that generates a Meeting SDK JWT via an HTTP request for authorized use of the Zoom Meeting SDK.

If you would like to skip these steps and just deploy the finished code to a managed service, click the Deploy to Railway/Render/Heroku button. (You will still need to configure a few simple things, so skip to Deployment.)

Railway Render Heroku
Deploy on Railway Deploy to Render Deploy

Note: Both Railway and Render have free tiers, but Heroku requires a credit card to deploy.

Installation

In terminal, run the following command to clone the repo:

$ git clone https://github.com/zoom/meetingsdk-auth-endpoint-sample.git

Setup

  1. In terminal, cd into the cloned repository:

    $ cd meetingsdk-auth-endpoint-sample

  2. Then install the dependencies:

    $ npm install

  3. Rename .env.example to .env, edit the file contents to include your Zoom Meeting SDK key and secret, save the file contents, and close the file.

  4. Start the server:

    $ npm run start

Usage

Make a POST request to http://localhost:4000 (or your deployed url) with the following request body:

Property Type Required? Validation Rule(s)
meetingNumber string Yes (web)* - Required if generating a web JWT, optional for native.
role number Yes (web)* - Required if generating a web JWT, optional for native.
- Must be equal to 0 or 1
expirationSeconds number No - Must be between 1800 (30 minutes) and 172800 (48 hours) seconds

Important

If meetingNumber or role are supplied in the request body, the other must be present as well. If both are supplied, the JWT will be valid for web, otherwise it will be valid for native.

Example Request

POST http://localhost:4000

Request Body:

{
  "meetingNumber": "123456789",
  "role": 0
}

If successful, the response body will be a JSON representation of your Meeting SDK JWT:

{
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZGtLZXkiOiJhYmMxMjMiLCJtbiI6IjEyMzQ1Njc4OSIsInJvbGUiOjAsImlhdCI6MTY0NjkzNzU1MywiZXhwIjoxNjQ2OTQ0NzUzLCJhcHBLZXkiOiJhYmMxMjMiLCJ0b2tlbkV4cCI6MTY0Njk0NDc1M30.UcWxbWY-y22wFarBBc9i3lGQuZAsuUpl8GRR8wUah2M"
}

In the Meeting SDK, pass in the signature to the join() function:

// Make http request to your auth endpoint to get the Meeting SDK JWT

// Meeting SDK - web - Client View - example:
ZoomMtg.join({
  signature: signature,
  sdkKey: sdkKey,
  userName: userName,
  meetingNumber: meetingNumber,
  passWord: password
})

// Meeting SDK - web - Component View - example:
client.join({
  signature: signature,
  sdkKey: sdkKey,
  userName: userName,
  meetingNumber: meetingNumber,
  password: password
})

Deployment

Deploy to a Managed Service

  1. After clicking the "Deploy to <Provider>" button, enter a name for your app (or leave it blank to have a name generated for you), and insert your Zoom Meeting SDK credentials:

    • ZOOM_MEETING_SDK_KEY (Your Zoom Meeting SDK Key or Client ID for Meeting SDK app type's created after February 11, 2023, found on your Zoom Meeting SDK App Credentials page)
    • ZOOM_MEETING_SDK_SECRET (Your Zoom Meeting SDK Secret or Client Secret for Meeting SDK app type's created after February 11, 2023, found on your Zoom Meeting SDK App Credentials page)

  2. Then click "Deploy App".

  3. Use your URL as your Meeting SDK Auth Endpoint.

    Example: https://abc123.provider.com/

$ curl <YOU_URL> -X POST -d '{  "role": "1", "meetingNumber": "123123123"}' -H "Content-Type: application/json"

Other Server Hosting

  1. For Other Server Hosting information, see this tutorial.

  2. Use your deployed URL as your Meeting SDK Auth Endpoint.

    Example: https://abc123.compute-1.amazonaws.com/

Now you can generate your Meeting SDK JWT.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.