The site below is not a comprehensive guide to use of the Canvas LMS, and our team can only assist with SWEAP integration. we are unable to provide support for any other aspect of Infrastructure’s functionality. Screenshots are provided for illustrative purposes but may not exactly match your own system, particularly since navigation elements can vary depending on your version of the platform.

SWEAP is capable of integrating with the Canvas Learning Management system via the external apps feature. For privacy concerns SWEAP is designed to work without the explicit need to send name or student email to our system, however if the identified version of the curriculum instrument is selected, the names will not appear. SWEAP recognizes that every program is different, and we suggest that you consult with your institution’s IT policies and procedures.

If you require the deprecated older versions of the documentation, it is available here: Integrate SWEAP with Canvas (LTI 1.1)

Create Developer Key

  1. As the LMS Administrator, log in to Canvas and select Admin from the left navigation.

  2. Click Developer Keys from the inner left navigation.
    Developer keys

  3. Select the blue Developer Keys button. Choose LTI Key from the dropdown menu, then Key Settings screen, enter the required information.


  4. For Redirect URI, enter https://sweapinstruments.org/lti/lti
  5. For Method, choose Manual Entry.
  6. Title is the name of the LTI 1.3 tool that you will send to instructors so they can add use the tool in their course.
  7. For the Target Link URI, enter https://sweapinstruments.org/lti/lti
  8. For OpenID Connection Initiation Url, enter the value https://sweapinstruments.org/lti/lti
  9. For JWK Method, choose Public JWK or use JWK URL of https://www.sweapinstruments.org/lti/lti/canvas
    1. If you’re using the Public JWK option, enter the value in the JWK box.
      {"kty":"RSA","n":"hIuhwulpfAXYMEIJHDY7Yrj9SWpH5X3nR4Z8luY46iKFjcqQ51GZWs-XyFkonjsLBJr6TGK0RPN0vgMS7DjwLaEDHzN61swYJ5II9cdDyTh-OZGenuWlHXQHsF3NQt4y0totMRmaY9hMddHPeTuWnrpW1gkhtmxajQGPQ_qaI8Kir89nefr-aO3z3QDNEY0uN3aTsdV_i3I5c7dr-q_9O-iEMngU5YMNd8QyH1MLZqFPZu94_b24_LyGiRqkGd1gCvaE1alpNav7bd6d00dLcRZqWGU6yKQjyLO_Kz_2veKBkpotyQlcE4nbv__6OS_-pb3GtZtXZPoJD6YWR08JUw","e":"AQAB","alg":"RS256","use":"sig","kid":"key-1"}
  10. Now scroll down to Placements.
  11. Delete Account Navigation, which is populated by default.
  12. Enter Editor and then select Editor Button to add it beside Link Selection.
  13. All URLs are https://sweapinstruments.org/lti/lti

Get The Client ID For Developer Key

  1. After you save the Key Settings screen, you will go back to the Developer Keys screen. Alternatively, log in to Canvas, select Admin from the left navigation, and select Developer Keys from the inner left navigation.
  2. Copy the Client ID from the Details column and start an email to the Site administrator who will complete the setup. Copy the value directly above Show Key. Don’t click Show Key to see and copy a longer ID. You want the shorter version. 
    Record this value for reference later.
  3. Enable the Developer Key.
    Client ID Zoom in

Install the Tool and Get the Deployment ID

  1. Log in to Canvas, select Admin from the left navigation, and choose the appropriate account.
  2. Select Settings from the inner left navigation.
  3. Select Settings from the inner left navigation, and then select the Apps tab at the top of the screen.
    Apps Highlight
  4. Click View App Configurations.
  5. Click + App.
  6. Select By Client ID.
  7. Enter the Client ID from the “Get The Client ID For Developer Key” step and select Submit.
  8. Go back to the External Apps screen to get the Deployment ID for the next step.
    Select the gear icon associated with the new LTI tool, and choose Deployment ID.
    get the deployment id

Configure SWEAP To Use Integration

  1. After getting the Client and Developer ID, you can now authorize the connection from the SWEAP side. Log into SWEAP and then go to The LTI 1.3 Settings Page. To gain access you can follow the instructions here: Adding Access To SWEAP

  2. Click Add New Integration, and fill out the data like so:
    highlight SWEAP website side config of where the developer and client ids go.
  3. Note if your institution uses hosted Canvas, the URLS are:
    1. Platform ID : https://canvas.instructure.com
    2. Auth Request URL: https://sso.canvaslms.com/api/lti/authorize_redirect
    3. Access Token URL: https://sso.canvaslms.com/login/oauth2/token
    4. Public Keyset (JWKS) URL: https://sso.canvaslms.com/api/lti/security/jwks
  4. Select Enabled – Use This Integration
  5. Save the integration in SWEAP

Adding Module Or Assignment To Canvas

  1. In canvas navigate to your course where you would like to integrate the selected SWEAP instrument. Click on Assignments, then Add. You will want to always create a new assignment instead of editing an assignment if you have an issue as a newly added integration will not be available.
  2. SWEAP supports grade postback, you may assign points to the assignment, all completed assessments will be graded at 100% for completed. SWEAP does not support the Complete/Incomplete grading option.
  3. Select Submission Type and pick External Tools.
  4. Under URL enter https://sweapinstruments.org/lti/index.php
  5. A configuration section should appear to enter the information found on step 1.
  6. Additional options may appear allowing for selection of what information will be sent to SWEAP.
  7. If you have this set up as an institutional central administration, you can add the step 1
  8. Press Save and Publish
  9. After saving a screen will appear to allow you to select what instrument you would like to be administered for this assignment.
    pick an option screen
  10. After saving you will see a confirmation screen:
    success integrating instrument