Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Canvas Integration

Rupesh Parab edited this page Mar 3, 2020 · 2 revisions

Canvas integration can be done using 2 major flows:

1) Access Token

Access token needs to be created by each user and configured into MathShare. Process for creating a token is documented here: https://community.canvaslms.com/docs/DOC-16005-42121018197

User Flow

User will follow the 4-5 steps mentioned in above doc and add the token along with the canvas site domain in MathShare. On completing this configuration, user will get the option to share/submit assignments on the canvas site.

Disadvantage:

The creation of the access token and its setup in MathShare is a manual step for the user

Advantage:

We don't need to control which user can access which institutes canvas lms, users have flexibility of setting up multiple institutes on their own.

2) OAuth

OAuth needs setup of Developer keys by Admin, its process is documented here: https://canvas.instructure.com/doc/api/file.developer_keys.html Here for each institute a client id and secret needs to be generated and configured in MathShare, also we will need a way to map the users of the institute to their MathShare account. Here the student will be redirected using an OAuth flow similar to Google or Azure.

User Flow

User will need to Authenticate MathShare to use apis of the Canvas institute site, this will be needed once until the access expires which will be dependent on the institute's OAuth configuration. Although this flow will be blocked until the Institute site admin shares the client id and secret with us and also gives a list of Users of MathShare who will have access to their institute.

Disadvantage:

If a teacher using Canvas LMS wants to use MathShare, they will need to wait for the admin to generate the developer keys and configure it into MathShare. If a new user is added to the institute, the institute site admin will need to map the user to their institute in MathShare

Advantage:

Teachers & Students don't need to configure their individual keys