How do I add an app using JSON URL?
Canvas Apps is the central hub to discover, manage, and monitor integrated apps. This feature aims to extend and enhance digital teaching and learning experience with powerful apps that provide and/or enrich content, assessment, multimedia, collaboration, analytics, accessibility, and more.
If you are a Canvas root admin with the LTI Registrations - Manage permission, you can add an external app (LTI tool) using JSON URL in the Canvas App page.
Note: Canvas Apps is available in Account Navigation and enabled for all institutions.
Open Account
In Global Navigation, click the Admin link [1] and then click the name of the account [2].
Open Apps
In Account Navigation, click the Apps link.
Add New App
Select Install Method
Select the LTI version number 1.3 [1]. In the Install Method drop-down menu, select the Enter URL option [2].
In the JSON URL field, enter the JSON code given to you by the tool provider [3]. Then, click the Next button [4].
Complete LTI 1.3 Registration
The LTI 1.3 Registration window displays the technical details needed for the configuration including the URIs used to identify resources from the tool, launch the tool, and authenticate the tool [1].
These values automatically populate based on the JSON you pasted on the previous screen. You can make changes if needed, however, this may prevent the tool from working properly.
Click the Next button [2].
To learn more about manual configuration, click the Canvas documentation link [3].
Set Permissions
To select which permissions you want to make available to the app, click the Permission toggle on [1]. Then, click the Next button [2].
Notes:
- For more information about the privacy impacts of these settings, visit the Privacy implications of installing an LTI 1.3 tool in Canvas resource document.
- Changing any of these settings may impact the tool’s ability to function in Canvas.
Set User Data-Sharing
Click the User Data Shared With This App drop-down menu [1] and then select what data the tool can access [2]. Options include:
- None (Anonymized)
- User's name only
- User's email only
- All user data
Click the Next button [3].
Set Placements
Select where the app can be accessed from [1] and then click the Next button [2].
Note: Each placement has an Information icon which shows a screenshot of the location in Canvas as well as a text description of it.
Override URIs
You can choose to override Target Link URIs for the placements you selected [1]. Some tools may be customized to launch to different URIs depending on where in Canvas they are launched from.
Click the Next button [2].
Add Nickname
You can add a nickname for the app [1], a short description [2], and a name for each placement [3]. Then, click the Next button [4].
Notes:
- The Nickname displays in the Manage page. You can use this to indicate any specifics about the tool that helps you identify it such as a campus, sub-account, or other feature.
- The Description field allows you to create a description for users of the tool to see in placements where it is enabled. You may also optionally label the tool differently in certain placements.
Configure Icons
If available, the app's icon URLs display. If the tool has a placement which will display a logo in Canvas, you may add the logo on this screen [1]. Then, click the Next button [2].
Review and Install App
Review all the details and then click the Install App button.
Manage App
After installation, the app appears in the Manage tab [1]. To manage the app, click the Options icon [2]. You can copy the client ID, edit the app, or delete the app [3].
You can also make the app available in the whole account or in specific courses using a client ID.
