Chat with us, powered by LiveChat Skip to main content
Echo360 Status: 

EchoVideo: Adding a REST API Integration for D2L Brightspace

Echo360
  • Updated

EchoVideo's REST API integration essentially provides EchoVideo with an "LMS / VLE course lookup by Instructor" capability. This integration provides two features:

  1. 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.
  2. 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:

  1. Register an OAuth 2.0 App in Brightspace using the information provided below.
  2. Copy the Client ID and Client Secret provided by Brightspace after app registration.
  3. Add a Desire2Learn API configuration in EchoVideo, using the copied credentials.
  4. 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

  1. Log into Brightspace as a Super Administrator.
  2. Click the Settings icon in the top right corner, and select Manage Extensibility from the Organization Related group of options.
    Brightspace super administrator settings menu with Manage Extensibility option identified for steps as described
  3. 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.
    Brightspace manage extensibility page with OAuth 2.0 tab selected and identified containing Register an App button for selection as described
  4. 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
  5. Enable the checkbox for I accept the Non-Commercial Developer Agreement.

    The figure below shows a completed application registration form.

    Completed Register an Application form in Brightspace with fields containing values provided in steps as described
  6. When finished, click Register to complete the registration and generate and display the necessary OAuth 2.0 credentials, as shown in the figure below.

    Leave this page open as you continue. You will copy and paste the ID and Secret values from this page into EchoVideo.

    Brightspace Register an Application page after submission showing client ID and client secret entries for use in steps as described
  7. Open a new browser tab or window, and log into EchoVideo as an administrator.
  8. Click the Settings icon in the upper-right corner of the screen.
  9. From the Settings menu, select Institution Settings.

    General settings appears and Basic Info is selected by default.

  10. Click Integration.
  11. From the middle panel, select LMS / VLE.

    The LTI 1.1 tab is selected by default.

  12. Click the API tab.
    EchoVideo LMS configurations page with navigation to page and API tab shown as described
  13. Optionally, toggle on Full Course Roster. When on, it provides the full course roster for Consolidated Analytics. This allows Instructors to see who has not yet watched a piece of media or engaged with polling questions in their LMS course rather than displaying only those users who have.
  14. Click Add Configuration as shown in the figure above.
  15. In the form that appears, from the drop-down, select Desire2Learn as the LMS Type.
  16. Enter a Name for the configuration.
  17. Enter the Brightspace Domain (base URL of your Brightspace instance). Desire2Learn API configuration form in EchoVideo with fields completed with values as described
  18. Return to the Brightspace window / tab and copy and paste the LMS API Client Id and LMS API Client Secret values generated by Brightspace into the corresponding fields of the EchoVideo API form.
  19. Click Save.
  20. In the API tab that appears with your new configuration, click Authorize as shown in the below figure.
    API tab of the LMS Configuration page in Echo360 with Authorize button identified for use as described
  21. 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 before accepting if you are not already logged in through this browser.

    After authorization, the popup closes and the API tab appears again.

  22. Click Test to ensure the configuration and communication works properly.
    API tab of the LMS Configuration page in Echo360 with Test button identified for use as described
  23. 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 figure below. 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. Your instructors will now see an Analytics tab in their main menu navigation, to access their LMS-course related media data.

API configuration test modal with Brightspace instructor email entered and corresponding courses listed indicating successful test as described

Related to