Setting up Zoom integration(SDK App)
This article will walk you through setting up a Zoom integration so you can use webinar modules and virtual Instructor Led classes. It covers how to set up the Zoom API Credentials, the mandatory fields to be added in the form, how to add scopes and permissions for the meeting, and how to add your Zoom API credentials to Academy of Mine.
Step 1: Setting up Zoom API Credentials
Integrating Zoom with Academy of Mine requires adding a Client ID/App SDK Key and Client secret/App SDK Secret from Zoom. If you don't have them already, detailed instructions for creating the SDK App Key and Secret can be found in the Zoom Developer Documentation.
Head to the Zoom App Marketplace. In top-right of the page, select the Develop dropdown, the click Build App.
Choose General App and select Create.
In the top-left corner, click on the app name to edit the auto-generated name. We recommend to name it "AOM Meeting Integration" or similar.
Next, continue with the Development mode.
On the Basic Information tab, copy down the Client ID and the Client Secret, as these will be used later.
Step 2: Mandatory Fields to be added in the Form
- Next, copy the Redirect URI from the Zoom Integration Settings page in your AOM platform.
Paste it in the OAuth Redirect URL and OAuth Allow Lists fields on Basic Information page on Zoom App Marketplace as shown below.
- Navigate to Embed option
Enable Meeting SDK.
Step 3: Add Scopes and Permissions for the Meeting
Click on the Scopes tab, then Add Scopes.
meeting:read:local_recording_token
meeting:read:meeting
meeting:update:meeting
meeting:read:participant
meeting:write:meeting
meeting:update:livestream
meeting:read:live_streaming_token
cloud_recording:write:recording_registrant
cloud_recording:read:list_recording_files
cloud_recording:read:list_user_recordings
Step 4: Adding Your Zoom API Credentials to Academy of Mine
- Return to your Academy of Mine account. From the Dashboard, click the Integrations tab.
On Zoom Meetings click Manage.
- Paste your Client ID in the Enter App SDK Key field and your Client Secret in the Enter App SDK Secret field.
- Make sure you Enable Zoom.
Click Save & Authorize. This will redirect you to a Zoom Connection Page, check the Checkbox and click Allow button.
- You will be redirected back to AOM and an "Authorized Successfully" message will appear.
Check out this article for the details on creating a webinar module.
Or, if you are doing virtual Instructor Led classes, see this article to create a virtual class.
Note: Sometimes Zoom generates an invalid Client ID/SDK Key. It's a known issue with Zoom. In that case, when you try to authorize the Zoom SDK key and Secret in your AOM account, it will throw an error. In such cases, you will have to create a new app following the same steps given above and try using the new Client ID/SDK Key and Client Secret/SDK Secret for authorization.
Important: On your Zoom account make sure to turn these two settings ON from Settings->Meetings
- Meeting Passcode
- Personal Meeting ID (PMI) Passcode
Then go to Account Management -> Account Setting (https://us06web.zoom.us/account/setting) -> Meeting and turn on the above two settings here also. An additional step is to turn on the lock beside the Meeting Passcode here to make the Zoom webinar work. Refer to the below images -