Connecting Canvas

Before We Get Started

1. 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.
2. Have you connected a learning app to Edlink before? If so, skip to Step 2: Completing the integration.

Step 1: Creating Canvas Developer Keys

Log into your Canvas admin account and navigate to the +Developer Key button in your Admin tab.

Select +API Key and insert the following details:

• Key Name: Edlink
• Owner Email: support@ed.link
• Redirect URIs: (Please note: These URIs should be on separate lines in this field.):

https://ed.link/api/authentication/canvas
https://ed.link/sso/administrator

All other fields should be left blank. Hit Save, and switch the State toggle next to the developer key to ON.

Step 2: Completing the Integration

The learning app you want to connect to should have sent you an integration link that looks like this:
https://ed.link/integrate/abc456789-efg456-123456

If you don't have the link, reach out to support@ed.link, and we will provide assistance.

The link will direct you to create an Edlink account.

If you've connected an app to Edlink before, please log in with that account.

Enter your Canvas domain (including https://) into the provided field. Next, copy and paste the Developer Key ID and Developer Key Secret into the respective fields.

Once all fields are completed, select Connect to link your account. You will be prompted by Canvas to authorize Edlink to access your account. Selecting Authorize will bring you back to Edlink.

Next, click Validate Your Configuration to confirm the integration has been configured correctly.

Scoping Canvas Developer Keys {scopes}

Edlink does support the use of API scopes, but it is not recommended at this time due to constraints in the Canvas API. The following are the scopes that Edlink needs:

• Select Allow include parameters
• Select Read Only scopes
• Select the following additional write scopes:
  • url:POST|/api/v1/courses/:course_id/assignments
  • url:PUT|/api/v1/courses/:course_id/assignments/:id
  • url:DELETE|/api/v1/courses/:course_id/assignments/:id
  • url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

Once you create the scoped developer key, you'll follow the same Edlink onboarding guide, with one difference. Select Advanced Options and Enable Scopes in the onboarding flow

Note: Applying scopes can break integrated functionalities in apps. We recommend that you test your integration before fully releasing it to your school or district.

🎉 Well done! You're now finished. 🎉

Any Questions?

If you still have questions, please contact our support team and we'll get back to you within 24 business hours.