Use this guide if the learning app asked you to connect LTI Advantage, not Canvas, as the data source. You will still install the tool in Canvas, but Edlink will not sync Canvas roster data over the Canvas API.
If you already connected Canvas as a data source and only need to add LTI, use this guide instead:
LTI 1.3 (Canvas + LTI)
Developer Guide
Please confirm with the learning app that an LTI-only source is something they support before proceeding.
You must be a Canvas Administrator to complete the integration process.
Canvas administrators will have an "Admin" tab on their left-hand sidebar. You must also have the ability to create API Developer Keys. If you do not see Developer Keys, reach out to your Canvas administrator to set up this connection.
Step 1: Start the Integration Flow in Edlink
- Click the integration link provided by your learning app. It will look something like this:
https://ed.link/integrate/cfacdefd-9bf4-4ec6-9bb9-000000000000
If you did not receive a link, please reach out to the learning app you are trying to connect to, or email support@ed.link. If you email support, include the name of the learning app you are trying to connect to. - Create an Edlink account if you don't already have one. If you've connected an app to Edlink before, log in with your existing account.
If you are not sure whether you have an Edlink account, search your email inbox for a previous login code fromsupport@ed.link. The subject will look something like "Your Login Code." All logins require an email code, so this is a good way to check if you have logged in before. - Choose your learning institution. If you have connected to Edlink before, you should see your district. If this is your first time, type your district name in the search bar and select it when it shows up.
If your district does not appear, click Use 'Learning Institution Name' to create a new district.
If your learning institution appears, but has already been claimed, please email support@ed.link. Include the learning app you are trying to connect to and the learning institution you are from.
- Search for LTI Advantage (not Canvas) from the list of available data sources.
- Choose your preferred data storage region.
Click Continue.
- Select Canvas as your LMS.
- Enter your Canvas URL.
You must includehttps://at the beginning of the URL. When you enter this correctly, the next step in the onboarding flow will be unlocked.
Click Continue. Leave this tab open. You will need it for later steps.
Step 2: Configure the LTI Advantage Tool in Canvas
- Click Click to open Canvas Developer Keys. This will take you to the Developer Keys section of your Canvas instance.
If this screen is a blank white page, refresh and continue to the next step.
- In Canvas, select + Developer Key → + LTI Key.
- Select LTI Key. A form will open where you can configure the tool.
Step 3: Enter the Configuration Details
- Select Enter URL as the configuration method.
- Complete the following fields:
- Key Name: Enter the name of the learning application.
- Owner Email: Enter
support@ed.link. - JSON URL: Copy the LTI Configuration JSON URL from the Edlink onboarding flow you left open in Step 1 and paste it here.
- Click Save.
- Toggle the Developer Key State to On.
Step 4: Unlock Your App
- Click View in Canvas Apps. This will open a new tab.
Leave the Developer Keys tab open. You will need it in later steps.
- In the new tab, click Unlock App.
- Click Copy Client ID.
After copying the Client ID, leave this tab open. You will need it for a later step.
Step 5: Enter Configuration Details in Edlink
- Return to the Edlink onboarding flow you left open in Step 1.
- Paste the Client ID into the Client ID field in Edlink.
- Click Validate Configuration.
- If the configuration is correct, you will see green check marks.
- If you do not see green check marks, click Continue Anyway and email support@ed.link to have the configuration reviewed.
After entering the Client ID, leave this tab open. You will need it in a later step.
Step 6: Add the App in Canvas
- In Canvas, navigate to Settings → Apps → View App Configurations.
- Click + App.
- For Configuration Type, select By Client ID.
- Paste the Client ID you copied in Step 4.
- Click Submit.
- When prompted, click Install.
Step 7: Add the Deployment ID to Edlink
- Return to the View in Canvas Apps tab you left open earlier. This is the tab where you unlocked your app in Step 4.
- Refresh the page.
- You should now see two deployments for the LTI tool:
- One not available deployment
- One available deployment
- Copy the Deployment ID from the available deployment.
- Return to the Edlink onboarding flow you left open in Step 5.
- Paste the Deployment ID into the Deployment ID field.
The deployment IDs shown above are only examples. You must use the Deployment ID from the Available installed key in your Canvas instance.
- Click Continue Setup.
- When asked whether you want to connect another source, select Skip Data Enrichment.
- Your integration has now been created. Click View Edlink Dashboard.
- Once you are redirected to the Edlink Dashboard, leave this tab open. You will need it in Step 8.
Step 8: Add Deep Linking to Your LTI Tool
In this step, you will configure deep linking for two placements. This allows the deep-linked tool to be accessed from multiple locations in Canvas.
- Return to the Developer Key you created in Step 2 and click the pencil icon to edit it.
- In the Placements field, you will see the following placements pre-added:
- Account Navigation
- User Navigation
- Course Navigation
- Link Selection
- In the text box, add Submission Type Selection.
Configure Link Selection
- Open the Link Selection dropdown.
- Under Select Message Type, select LtiDeepLinkingRequest.
- You will need the Configuration JSON URL from the Edlink Dashboard to create the Target Link URI.
- Return to the Edlink Dashboard tab you left open in Step 7.
- Click Integrations on the left-hand side.
- Find the appropriate integration and select it.
If you have connected to a learning app via Edlink before, you will see multiple integrations on this screen. Be sure to select the learning app you are currently configuring.
- Locate the LTI Configuration section.
- Find the Configuration JSON URL and click it to copy the URL.
- Return to Canvas and paste the Configuration JSON URL into the Target Link URI field.
- Add
/launchto the end of the URL you pasted in.
Your Target Link URI should look similar to:https://ed.link/api/authentication/lti/00000000-0000-0000-0000-000000000000/launch
The URL above is only an example. You must use the URL associated with your integration in the Edlink Dashboard, followed by
/launch.
- Complete the remaining fields:
- Icon URL: Editable; choose the icon you want displayed.
- Text: Editable; enter the text you want displayed.
- Selection Height:
600 - Selection Width:
800
Configure Submission Type Selection
You will enter the same configuration details for Submission Type Selection as for Link Selection.
- Open the Submission Type Selection dropdown.
- Paste the same URL into Target Link URI and ensure
/launchis at the end.
Your Target Link URI should look similar to:https://ed.link/api/authentication/lti/00000000-0000-0000-0000-000000000000/launch - Complete the remaining fields:
- Icon URL: Editable; choose the icon you want displayed.
- Text: Editable; enter the text you want displayed.
- Selection Height:
600 - Selection Width:
800
- Click Save.
Well Done!
You have successfully created an LTI Advantage integration for Canvas and installed your learning application as an LTI tool!
Any Questions?
If you have any questions or encounter issues, please contact our support team. We'll respond within 1 business day.