EchoVideo's REST API integration essentially provides EchoVideo with an "LMS/VLE course lookup by Instructor" capability. This integration provides two features:
- The ability for EchoVideo admins or schedulers to create both EchoVideo sections and connect capture schedules directly to LMS Courses. This is described in Linking an EchoVideo Capture Schedule to an LMS Course.
- The ability for instructors to see and use the consolidated Analytics tab, which provides viewing and polling response data in one place for all of their LMS-course-related EchoVideo media.
The basic process for API integration is:
- Register an OAuth 2.0 App in Brightspace using the information provided below.
- Copy the Client ID and Client Secret provided by Brightspace after app registration.
- Add a Desire2Learn API configuration in EchoVideo, using the copied credentials.
- Authorize and test the configuration.
The configuration process described on this page requires that you log into D2L Brightspace as a user with Super Administrator privileges.
To configure an API integration between Brightspace and EchoVideo
- Log into Brightspace as a Super Administrator.
- Click the Settings icon in the top right corner, and select Manage Extensibility from the Organization Related group of options.
- Access the OAuth 2.0 tab, and click the Register an app button, identified in the below figure.
If you have other OAuth 2.0 apps already registered, they are listed on this page. - In the Register an Application form that appears, complete the fields using the following values:
- Application Name: Your preferred registration name (e.g., Echo360 API)
- Redirect URI: https://{echo360 domain}/lms/api/oauth2/complete
- Scope: application:*:* core:*:* courses:*:* data:*:* enrollment:*:*
- Access Token Lifetime (seconds): 3600
- Enable the checkbox for I accept the Non-Commercial Developer Agreement.
The figure below shows a completed application registration form.
- When finished, click Register to complete the registration and generate and display the necessary OAuth 2.0 credentials, as shown in the below figure.
Leave this page open as you continue; you will copy and paste the ID and Secret values from this page into EchoVideo.
- Open a new browser tab or window, and log into EchoVideo as an administrator.
- Click the Settings icon in the top right of the main menu bar, then select Configurations, as shown in the below figure. The LMS Configurations tab is shown by default.
- In the main panel of the page, click the APIs tab, as identified in the above figure.
- Click Add.
- In the form that appears, shown below, select Desire2Learn as the LMS Type.
- Enter a Name for the configuration.
- Enter the your Brightspace Domain (base URL of your Brightspace instance).
- Return to the Brightspace window/tab and copy and paste the Client ID and Client Secret values generated by Brightspace into the corresponding fields of the EchoVideo API form.
- Click Save.
- In the API tab that appears with your new configuration, click Authorize as shown in the below figure.
- In the popup window that appears, click Accept on the request to allow the EchoVideo app you just created to operate using your account. You may be asked to log into D2L prior to accepting, if you are not already logged in through this browser.
After authorization, the popup closes and the API tab appears again.
- Click Test to ensure the configuration and communication works properly.
- In the popup that appears, enter an email address for a Brightspace instructor known to be enrolled in Brightspace courses, then click Search.
If the configuration is successful, the bottom section of the test modal is populated with a list of that instructor's Brightspace courses, as shown in the below figure. You can close the dialog box using the X in the top right corner.
You are done! You can now Link your EchoVideo capture schedules to LMS courses. And your instructors will now see an Analytics tab in their main menu navigation, to access to their LMS-course related media data.