Configuring REST API Plugin with Moodle Follow

IMPORTANT: Zoom’s LTI Pro app is now available in the new Zoom Marketplace.  LTI Pro should be used instead of the LTI documented in this article.  If you are already using the LTI documented in this article, read how to migrate to LTI Pro and how long this LTI will be supported.

Overview

The REST API Plugin offers tight integration with Moodle, supporting meeting creation, synchronization, grading, and backup/restoration. More information can be found here.

Prerequisites

  • Pro, Business, Education, or API Partner plan
  • You must have access to our REST API
  • Moodle admin access

Instructions

  1. Login to Moodle as an administrator.
  2. Select Site Administration on the left.
    Screen_Shot_2017-12-28_at_11.51.18_AM.png
  3. Click the Plugins tab.
    Screen_Shot_2017-12-28_at_12.11.48_PM.png
  4. Click Install plugins.
    Screen_Shot_2017-12-28_at_11.51.24_AM.png
  5. Install the plugin via ZIP file. The ZIP file can be found here. 
    Screen_Shot_2017-12-28_at_11.51.55_AM.png
  6. Select Continue on the installation page.
    Screen_Shot_2017-12-28_at_11.52.08_AM.png

  7. Click Upgrade Moodle database now to install the plugin. 
    Screen_Shot_2017-12-28_at_2.58.41_PM.png
  8. You will be notified it was installed successfully. Click Continue.
    Screen_Shot_2017-12-28_at_3.00.06_PM.png
  9. Gather the REST API Key and Secret from Zoom Marketplace.
  10. Sign In to Marketplace, click Develop, then click Build App.
  11. Create a JWT app, give it a name, then click Create again. Input your Company Name, Name and Email Address, then click Continue.
  12. Your API key and secret will be displayed. Leave this page open so you can copy them for the next step.
  13. Complete the Moodle Settings:
    • Zoom API url: Leave this as the default.
    • Zoom API key: Copy this from the Zoom Marketplace JWT App Credentials page.
    • Zoom API secret: Copy this from the Zoom Marketplace JWT App Credentials page.
    • Zoom home page URL: This is your Vanity URL landing page or https://zoom.us if you do not have a Vanity URL.
    • Login types: Hold down CTRL on PC or Cmd on Mac to select all options except API. 
      b5f73044-0591-4ead-88d6-c642d6e9b004.png
  14. After saving changes, verify the plugin has installed by selecting Site Administration.
    Screen_Shot_2017-12-28_at_11.51.18_AM.png
  15. Select Plugins.
    Screen_Shot_2017-12-28_at_12.11.48_PM.png
  16. Under Activity Modules, select Zoom meeting.Screen_Shot_2017-12-28_at_2.54.29_PM.png
  17. The page will show the following message if installed properly
    Screen_Shot_2017-12-28_at_2.55.07_PM.png

Usage

Follow the documentation found here to use the REST API Plugin within Moodle.

Was this article helpful?