Schoolyear offers a seamless integration with Canvas, allowing you to secure your quizzes with ease. The integration supports both Classis and New quizzes. This guide will walk you through the process of installing and configuring the Schoolyear integration in your Canvas environment.
Before you begin, the following is required:
- Schoolyear admin account to create an add-on in the Admin Console
- Canvas admin to create an API-key, LTI, key and install the app.
To install and activate the integration, the following steps are required:
Step 1:
- Log in to the Schoolyear Dashboard and open the admin console.
- Navigate to add-ons and click on the "add" button. Select the Canvas icon from the list.
- Give the add-on a name and proceed to the next step.
Step 2:
- Log in to Canvas and open the Admin Page.
- Navigate to developer keys.
- Click on the "+ Developer Key" button and select LTI-key.
- Under Method, select "Enter URL"
- Paste the URL which is provide in the admin console of Schoolyear into this field and click save.
- Once the LTI-key is created, make sure the key is active by changing the state.
- Copy the clientID and the client secret from Canvas and paste these in the admin console of Schoolyear.
- Proceed to the next step.
Step 3:
- Log in to Canvas and open the Admin Page.
- Navigate to developer keys.
- Click on the "+ Developer Key" button and select API-key.
- Under "redirect URL", paste the URL which is provide in the admin console of Schoolyear into this field and click save.
- Once the API-key is created, make sure the key is active by changing the state.
- Copy the clientID and the client secret from Canvas and paste these in the admin console of Schoolyear.
- Provide your Canvas base URL.
- Proceed to the next step.
Step 4:
- Download the Java Script from the Schoolyear admin console.
- Log in to Canvas and open the Admin Page
- Navigate to "themes"
- Open your current theme and click on "upload"
- In the Java Script field, upload the Java Script that you just downloaded in the admin console.
- Note: if you already have a custom Java Script uploaded, you need to add the JavaScript from Schoolyear to your custom Javas Script file.
- Save the updated them and proceed to next step.
Step 5:
- Log in to Canvas and open the Admin Page.
- Navigate to "Settings".
- Navigate to "Apps".
- Click on "view App Configurations"
- Click on +App and under configuration Type, select By Client ID
- Paste the clientID from the Schoolyear dashboard into the ClientID field of Canvas.
- Click Submit and install the Schoolyear app.
- Proceed to the next step.
Step 6:
- Navigate back to the Schoolyear admin console and click on Save in the right top corner. The add-on is now configured and you can now use the Canvas integration.
See the following instructions to learn more on how the integration works: