/videosdk-auth-endpoint-sample

Generate a Video SDK JWT to join Zoom Video SDK sessions with the Video SDK.

Primary LanguageJavaScriptOtherNOASSERTION

Zoom Video 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 Video SDK JWT via an http request for authorized use of the Zoom Video SDK.

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

Deploy

Installation

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

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

Setup

  1. In terminal, cd into the cloned repo:

    $ cd videosdk-auth-endpoint-sample

  2. Then install the dependencies:

    $ npm install

  3. Create an environment file to store your Video SDK credentials:

    $ touch .env

  4. Add the following code to the .env file, and insert your Zoom Video SDK credentials:

    ZOOM_VIDEO_SDK_KEY=VIDEO_SDK_KEY_HERE
ZOOM_VIDEO_SDK_SECRET=VIDEO_SDK_SECRET_HERE

  5. Save and close .env.

  6. Start the server:

    $ npm run start

Usage

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

Key Value Description
sessionName Required, a session name of your choice.
role Optional, 0 to specify participant, 1 to specify host. If the role is not set, the first person who joins will be the host. Everyone else will be a participant. If the role is set, the host must join before the participants.
sessionKey Required if set with the host. A key you can provide to identify your sessions. This value will show up in the Video SDK APIs and Dashboard. If set with the host, the sessionKey needs to match for all participants.
userIdentity Optional, an identifier you can provide to identify your users. This value will show up in the Video SDK APIs and Dashboard.
geoRegions Optional, the data center connection preference for the user joining the session. The data center/s you specify must also be enabled on your account. Comma seperated string of the following supported geo regions US, AU, CA, IN, CN, BR, MX, HK, SG, JP, DE, NL. Abreviation reference here.
cloudRecordingOption Optional, 0 for a cloud recording file with user videos combined into one, default.
1 for separate cloud recording video files for each user. Contact Sales to enable. Can only be set by the host (role_type of 1).
cloudRecordingElection Optional, 1 to record this user's self view, default.
0 to not record this user's self view.

Example Request

POST http://localhost:4000

Request Body:

{
  "sessionName": "Cool Cars",
  "role": 1,
  "sessionKey": "session123",
  "userIdentity": "user123"
}

If successful, the response body will be a JSON representation of your signature:

{
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBfa2V5IjoiVklERU9fU0RLX0tFWSIsImlhdCI6MTY0NjI0ODc5NiwiZXhwIjoxNjQ2MjU1OTk2LCJ0cGMiOiJDb29sIENhcnMiLCJ1c2VyX2lkZW50aXR5IjoidXNlcjEyMyIsInNlc3Npb25fa2V5Ijoic2Vzc2lvbjEyMyIsInJvbGVfdHlwZSI6MH0.Y6C65mZUxTZFeGiOI6oW5q2UkIXe3nLTK0MVNkfiJ9c"
}

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

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

// Video SDK - web - example:

client.join(
   signature: signature,
   topic: sessionName,
   userName: userName,
   password: sessionPasscode
)

Deployment

Heroku (button)

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

    • ZOOM_VIDEO_SDK_KEY (Your Zoom Video SDK Key, found on your Zoom Video SDK App's Credentials page)
    • ZOOM_VIDEO_SDK_SECRET (Your Zoom Video SDK Secret, found on your Zoom Video SDK App's Credentials page)

  2. Then click "Deploy App".

  3. Use your Heroku URL as your Video SDK Auth Endpoint.

    Example: https://abc123.herokuapp.com/

Heroku (CLI)

  1. If you cloned this repo, you may use the Heroku CLI to deploy your server. Remember to set your config vars (envoirnment variables).

  2. Use your Heroku URL as your Video SDK Auth Endpoint.

    Example: https://abc123.herokuapp.com/

Other Server Hosting

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

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

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

Now you can generate your Video 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.