This guide provides instructions on integrating SmartSpeaker with your D2L Brightspace instance using your Client ID and Client Secret. Please ensure you have access to your SmartSpeaker Platform before proceeding with the steps below. If you have any questions regarding the steps in this process, please contact your dedicated Account Manager.
Generating a D2L Brightspace Client ID and Secret
- Log in to D2L Brightspace as a Super Admin.
- Click the Gear > Manage Extensibility.
- Click OAuth 2.0 > Register an app.
- Fill out the information as shown below.
- Application Name: SmartSpeaker OAuth API
-
Redirect URl: Enter the URL based on your zone.
- US Zone: https://smartspeaker-api.yuja.com/d2l-auth/oauth
- CA Zone: https://smartspeaker-api-cz.yuja.com/d2l-auth/oauth
- EU Zone: https://smartspeaker-api-ez.yuja.com/d2l-auth/oauth
- AUS Zone: https://smartspeaker-api-az.yuja.com/d2l-auth/oauth
-
Scope: There are two available scopes you can enter, depending on the level of access you want to grant SmartSpeaker.
-
Default (Recommended): With the default scope, SmartSpeaker will be accessible in all course content, including the Assignments section. To grant these permissions, copy and paste the following scope:
- organizations:organization:read orgunits:course:read enrollment:orgunit:read checklists:checklist:read content:modules:readonly content:topics:readonly content:file:read content:toc:read discussions:forums:readonly discussions:topics:readonly dropbox:folders:read managefiles:files:read news:newsitems:read quizzing:quizzes:read surveys:surveys:read checklists:checklist:write content:modules:manage content:topics:manage discussions:forums:manage discussions:topics:manage dropbox:folders:write managefiles:files:manage news:newsitems:manage quizzing:quizzes:write surveys:surveys:update core:*:*
-
Disable Access to Assignments: If you DO NOT want to grant SmartSpeaker access to the Assignments section of your D2L Brightspace instance, copy and paste the following scope:
- organizations:organization:read orgunits:course:read enrollment:orgunit:read checklists:checklist:read content:modules:readonly content:topics:readonly content:file:read content:toc:read discussions:forums:readonly discussions:topics:readonly dropbox:folders:read managefiles:files:read news:newsitems:read quizzing:quizzes:read surveys:surveys:read checklists:checklist:write content:modules:manage content:topics:manage discussions:forums:manage discussions:topics:manage dropbox:folders:write managefiles:files:manage news:newsitems:manage quizzing:quizzes:write surveys:surveys:update
-
Default (Recommended): With the default scope, SmartSpeaker will be accessible in all course content, including the Assignments section. To grant these permissions, copy and paste the following scope:
- Access Token Lifetime (Seconds): 7200
-
Check the following:
- Prompt for user consent
- Enable refresh tokens
- I accept the Non-Commercial Developer Agreement
- Click Register.
- You'll be redirected to the details of the registered app. Note the Client ID and Client Secret, as they will be required to complete the setup in the next section of this guide.
Integrating D2L Brightspace with SmartSpeaker
After obtaining your Client ID and Client Secret, you will need to establish a connection between your D2L Brightspace instance and SmartSpeaker.
- Log in to your SmartSpeaker Platform. Click Configuration, and then select Integration Settings.
- Under the Select Integration drop-down menu, choose LMS API.
- Click Add Access Key.
- Select Client ID.
- Enter the Client ID and Client Secret using the information provided in step 6 of the previous section.
- If you selected the default scope in step 4 of the previous section, set Allow Assignment Access to Enabled. Otherwise, leave it Disabled.
Important: If you see the option for Allow Write Access, please ensure it is Disabled. - Click Authenticate With D2L Brightspace.
- In the new tab that opens, copy the authentication response and paste it in the space provided under D2L Brightspace Authentication Response.
- Click Add Access Key.
- Click Save Changes. SmartSpeaker will now be able to retrieve information from your D2L Brightspace instance. You can choose which courses or orgs SmartSpeaker can access by going to Configuration > Scope Settings from the navbar.
Adding SmartSpeaker to the D2L Brightspace Navbar
Proceed with this section of the guide once SmartSpeaker has been successfully added to your D2L Brightspace instance.
- Log in as an Admin or Instructor and select the course you wish to add the SmartSpeaker Platform to.
- Next, click the Actions for Navbar icon and select Edit This Navbar.
- Enter a Name for the Navbar.
- Click Add Links.
- Click Create Custom Link.
- In the Name field, enter SmartSpeaker, and then click Insert Quicklink.
- Locate and select External Tool from the list of Course Materials.
- Use the search bar to search for the SmartSpeaker tool.
- Click the tool to add it to your custom link.
- Set the Behavior to Same window, and click Create to add the SmartSpeaker tool to your Navbar.