General
Usage
The Canvas portal LTI Advantage integration simply allows further Canvas experience level integrations, so be sure to check out our canvas experience integration article.
How to
Install Riipen in Canvas with LTI Advantage
To install Riipen as a LTI Advantage application in Canvas, follow all of these steps from inside of your Canvas instance.
Initial Setup
Click on "Admin" from the main navigation
Select the account to install Riipen on
Click "Developer Keys"
Click "+ Developer Key" and click "LTI Key"
On the left, enter the following values:
Key Name: Riipen LTIA
Redirect URIs: https://app.riipen.com/ltia/launch
On the right, enter the following values:
Method: Enter URL
JSON URL: https://app.riipen.com/ltia/config
Click "Save"
On the Developer Keys page, you should see a new entry for "Riipen LTIA". Ensure the state is set to ON, and take note of the number displayed under the Details column; this is the Client ID for the Riipen LTIA developer key. Copy this value for use later.
Deploy the Tool
Now add Riipen as an account-wide app available to instructors. To do this from the administrator menu:
Click "Settings"
Click "Apps"
Click "+ App" (if not visible click "View App Configurations" then click "+ App")
Select "By Client ID" for "Configuration Type"
Paste in the Client ID for the Riipen LTIA developer key you created
Click "Submit"
Click "Install"
Find "Riipen" in the list, click the gear button to the right, and click "Deployment ID". Copy this value for use later
Create an API Key
The API currently supports importing users, groups, and sections from Canvas.
Click on "Admin" from the main navigation
Select the account you are installing Riipen on
Click "Developer Keys"
Click "+ Developer Key" and click "API Key"
On the left, enter the following values:
Key Name: Riipen API
Redirect URIs: https://app.riipen.com/ltia/oauth/response
Turn off "Enforce Scopes"
Click "Save"
Copy the "API Key secret" for use later
On the Developer Keys page, you should see a new entry for "Riipen API". Ensure its state is set to ON, and take note of the number that is displayed under the Details column; this is the Client ID forthe Riipen API developer key. Copy this value for use later.
If your organization must enforce scopes, the following must be enabled as part of step 3 above:
url:GET|/api/v1/courses/:course_id/groups
url:GET|/api/v1/groups/:group_id
url:GET|/api/v1/groups/:group_id/users
url:GET|/api/v1/group_categories/:group_category_id/groups
url:GET|/api/v1/courses/:course_id/group_categories
url:GET|/api/v1/users/:user_id/profile
url:GET|/api/v1/courses/:course_id/sections
Enable Canvas LTI Advantage integration in Riipen
The following steps can be completed by administrator of a portal. Within your portal on Riipen:
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "LTI Advantage" option under the "Learning Tool Interoperability (LTI)" section.
Fill in all the fields with the appropriate values (see below)
Click "Submit" to finish enabling the integration.
Field | Value |
LMS Host URL | Input your Canvas instance domain name. Example: myschool.instructure.com |
Client ID for LTI Developer Key | Input the Client ID from the Riipen LTIA developer key you created. |
Client ID for API Developer Key | Input the Client ID from the Riipen API developer key you created. |
Key for API Developer Key | Input the secret from the Riipen API developer key you created. |
Deployment ID | Input the deploy ID from the app you created |
Disable the Canvas LTI Advantage integration in Riipen
Click "Settings" below the "Portal" group in the main navigation.
Select the "Integrations" tab.
Select the "LTI Advantage" option under the "Learning Tool Interoperability (LTI)" section.
Click on the "Delete" button to remove the integration.
Removing the portal level Canvas LTI Advantage integration will remove all Canvas LTI Advantage integrations for experiences within the portal.