Overview

The CYPHER Learning platform allows you to integrate with many popular third-party web conferencing systems to schedule meetings directly in the platform.  

Configuring ZoomUS API integration

In order to set up the ZoomUS API integration, first, you must have an account on https://zoom.us/. 

Once you have created an account, install the ZoomUS API app. To install the ZoomUS API app, administrators:

1. Hover over Admin on the primary navigation menu.
   
2. Click App center from the fly-out menu.
   
3. Click Install on the ZoomUS API app.

1. From the App center:
   
1. Click the cog  icon on the ZoomUS API tile in the App center (shown in the screenshot below).
   
2. From any other page:
   
1. Hover over Admin on the primary navigation menu.
   
2. Click ZoomUS API from the fly-out menu. 
   

The Configuration page displays.

1. Click Configure.
   

1. Client ID
   
2. Client section
   
3. Account ID

Create and configure an app on Zoom

Pease refer to the Zoom documentation for the latest instructions on creating a Serve-toServer OAuth app

1. In a new browser window, login to the Zoom App Marketplace using an account with developer permissions.
   
2. In the upper right corner, click the Develop drop-down menu.
   
3. Select Build App from the menu.
   
4. On the Choose your app type screen, click Create on the Server-to-Server OAuth app tile.
   
5. Name the app.
   

1. Click Continue.

The Information tab displays.

1. You must enter a Company Name, and a Developer Contact Name and Email to create the app.
   
1. The additional information fields are optional. 
   
2. Click Continue.

The next section is Feature.

1. Event subscriptions are not currently supported, so leave this disabled.
   
2. Click Continue.

The next section is Scopes. To add scopes:

1. Click Add Scopes.
2. Use the search bar to add the following scopes (copy the italicized text to locate the scopes):
   
1. Meetings:
   
1. Create a meeting for a user: meeting:write:meeting:admin
   
2. Update a meeting: meeting:update:meeting:admin
   
3. Delete a meeting: meeting:delete:meeting:admin
   
2. Reports:
   
1. View meeting participant reports: report:read:list_meeting_participants:admin
   
3. Click Done.
   
4. Click Continue.

1. Click Activate your app.
   
1. If you see errors that prevent activation, please address them. You will not be able to generate an access token to make API calls unless your app is activated. 
   

Now, return to the App Credentials tab:

1. Click App Credentials from the left menu.
   
2. Copy the Client ID, Client Secret, and Account ID.
   

Paste your App Credentials in CYPHER Learning:

Toggle back to CYPHER Learning and enter the values in your Zoom configuration settings:

1. Enter the Client ID.
   
2. Enter the Client secret.
   
3. Enter the Account ID.
   
4. Click Save.
   

The ZoomUS API is now active.

Creating Zoom meetings 

You can now create Zoom meetings in the learning platform using the calendar, by adding a Web conferencing section to a module, and through the HTML editor. The example below will walk you through scheduling a Zoom meeting using the portal calendar:

1. Click full calendar in the Calendar widget in the right panel.
   
2. Hover over the date of the meeting and click the add icon.
   
3. Enter Summary details for the meeting.
   
4. Click the Web conferencing tab.
   
5. Select ZoomUS API.
   
1. Note that only the web conferencing apps configured on your platform will display.
6. Review and complete applicable settings in the Description, Repeat, and Miscellaneous tabs.
   
7. Click Save. 

The meeting is also added to your Zoom account.

Troubleshooting

1. Error Message: “ZoomUS API: User does not exist: email@example.com.”
   
2. Solution: This indicates that the email address is missing from Zoom. A user needs to be created with the same email address on the Zoom portal in order to use the ZoomUS API. Add the user’s email address and try again.