Deployment Guide LTI 1.3
This guide describes how to add the Annoto App for Canvas with LTI version 1.3 to your Instructure Canvas environment. This guide is intended for Canvas and Annoto administrators.
The Annoto App for Canvas is implemented as a set of LTI external tools. The tools are added manually through the addition of an LTI Developer Key in Canvas.
- A Canvas Administrator account
- A link to the JSON Configuration (provided by Annoto, If you do not have this information, please contact us [email protected])
- Redirect URIs (provided by Annoto, If you do not have this information, please contact us [email protected])
Example:
https://auth.eu.annoto.net/hosts/fcd8cfab-34ee-40b5-b409-3dee803ce098/lti/app
https://auth.eu.annoto.net/hosts/fcd8cfab-34ee-40b5-b409-3dee803ce098/lti/embed/select
https://auth.eu.annoto.net/hosts/fcd8cfab-34ee-40b5-b409-3dee803ce098/lti/embed/launch
https://auth.eu.annoto.net/hosts/fcd8cfab-34ee-40b5-b409-3dee803ce098/lti/dashboard/launch
Deployment Instructions
Create the LTI Developer Key in Canvas
- 1.Login to your Canvas instance with an Account Admin user account.
- 2.Click the following to launch the LTI Developer Key Settings page.
- Click the Admin tab.
- Click the Developer Keys tab
- Click “+ Developer Key”
- Click “+ LTI Key”
- 3.In the Key Settings page
- Change the Method to “paste JSON”
- Set Key Name = “Annoto LTI Advantage”
- Set Owner email = optional
- Notes = optional
- For the LTI 1.3 Configuration value copy the JSON code from the link (provided by Annoto) to the JSON Configuration and paste it instead of the displayed brackets
JSON Configuration
Before
After
- Replace the current Redirect URIs with the once's provided by Annoto, If you do not have this information, please contact us [email protected]
- Click Save.
- 5.The new LTI Developer Key will now be listed on the Developer Keys page. If the Status is set to “OFF” with a red box around it, it means the key is disabled. To enable the key click the “On” button. When the key is enabled “On” will be within a green box.
- 6.Send the Client ID to Annoto
Adding the Annoto App for Canvas Tools in Canvas
- 1.Log into Canvas as an Admin
- 2.navigate to the Developer Keys page. Admin > Developer Keys (https://{your_Canvas_base_URL}/accounts/1/developer_keys).
- 3.On the Canvas Developer Keys page locate the listing for the developer key you created in the steps for Create the LTI Developer Key in Canvas.
- 1.Copy the Client ID that is listed for the LTI Developer Key in the Details column.
- 2.Navigate to the Account Settings page. Admin > Settings (https://{your_Canvas_base_URL}/accounts/1/settings#tab-settings).
- 3.In the settings tabs click on “Apps”.
- 4.On the Apps page click the “View App Configurations” button.
- 5.On the External Apps page click the “+ App” button.
- 6.On the Add App page
- Click on the “Configuration Type” drop down menu and select “By Client ID”.
- Paste the Client ID copied in step 4 into the Client ID field
- Click "Submit".
Quick Test that everything is working as expected:
To learn how to access the Annoto Dashboard in your Canvas, go to How to access Annoto Dashboard page.
In order to learn more about all the wonderful things you can do with Annoto, visit the Annoto Widget Guide page.
Last modified 1mo ago