Configuring Edfinity as an external tool in Canvas (Administrator's guide)

If you are unfamiliar with installing a tool in Canvas using LTI Advantage, please read Canvas's guide before starting.

1. Configure a key for Edfinity in Canvas

Choose one of the two options below to create a Developer Key.

Option 1: Dynamic registration

This option saves time and reduces the risk of errors.

  1. Log into your Canvas account as an administrator and visit Admin > Site Admin > Developer Keys.
  2. Select the + Developer Key button, using the + LTI Registration option.
  3. Use the following value for Dynamic Registration Url: https://edfinity.com/ltia/registration/dynamic
  4. Select the Continue button.
  5. Select the Click to continue button after seeing the message "Registration was successful." If after selecting this button you receive an error message, choose the Close button and try the registration again making sure to choose the Click to continue button once visible.
  6. The Register App section will now be visible. Choose Enable & Close to continue.
  7. Ensure your new key has the state ON.

Option 2: Manual registration

Use this option if the above method fails, or if you are more familiar with this approach.

  1. Configure a key for Edfinity in Canvas
    1. Log into your Canvas account as an administrator and visit Admin > Site Admin > Developer Keys.
    2. Select the + Developer Key button, using the + LTI Key option.
    3. Choose the configure method of Enter URL.
    4. Specify the following:
      1. JSON URL = https://edfinity.com/ltia/configure.json
      2. Key Name = Edfinity
      3. Owner Email = <your email address>
      4. Redirect URIs = https://edfinity.com/ltia/launches
    5. Select Save.
    6. Set the state of your newly-created key to ON.
  2. Register a tool for Canvas in Edfinity
    1. If you don't already have one, sign up for an Edfinity account. For account type, choose Educator. 
    2. In your browser, go to https://edfinity.com/ltia/registration.
    3. Specify the following:
      1. Platform Root URL = https://canvas.instructure.com (This is the same for all Canvas installations, self-hosted or not.)
      2. Client ID = <long number in the "Details" column of your newly-created key>
        (Note: this should be a string of all digits, not a mix of letters and digits.)
    4. Make note of your Canvas domain: the first part of the URL, between the "https://" and the first "/". You'll use in the next three fields.
    5. Specify the following:
      1. Key Set URL = https://<your Canvas domain>/api/lti/security/jwks
      2. Authorization Token URL = https://<your Canvas domain>/login/oauth2/token
      3. Authorization Login URL = https://<your Canvas domain>/api/lti/authorize_redirect
    6. Click Save.

2: Add the Canvas App

Adding the app using these steps will show an Edfinity navigation link for all users. Add the link to a Canvas sub-account or individual course if you'd prefer to restrict visibility.

  1. Return to your new Canvas LTI Developer key and again copy the Client ID from the Details column.
  2. Visit to Admin > Settings > Apps.
  3. Select the + App button.
  4. Choose Configuration Type of By Client ID.
  5. Paste your Client ID from Step 1 and click Submit.
  6. Select the Install button to finish.

Your Canvas/Edfinity integration is now ready for use by educators.

Related articles