Set-Up Your Canvas Integration (Steps for Canvas Account Admins)

Create a New API Key

1. Log in to Canvas with administrator credentials
2. In the left-hand navigation, click Admin.
3. In the Admin panel, select your root account.
4. In the left menu under the root account, click Developer Keys.
5. On the Developer Keys page, click + Developer Key.
6. Choose API Key.

Access the ASSISTments OAuth Sign Up Page

1. In a new browser tab, open this link: Create a developer key for ASSISTments

Enter Key Details in Canvas

1. Return to Canvas and fill in the Key Name and the details provided by ASSISTments.
2. Turn on Enforce Scopes

3. Select ALL the Required Scopes listed on the “Create a developer key for ASSISTments” page.
4. Click Save Key.

Complete the Integration in ASSISTments

1. On the “Create a developer key for ASSISTments“ page, click Next.
2. Copy the Client ID and Client Secret from your new key and enter them into the specific sections on the OAuth Sign Up page.
   
   • Client ID is the visible number in the “Details” column.
   • Client Key can be found by clicking Show Key.

Activate the Key

1. In the Developer Keys list, make sure the State is toggled to ON (green).
2. ASSISTments is successfully installed if the Canvas administrator sees this pop-up message after installing

‍

Once the integration is complete, teachers can begin using ASSISTments in Canvas without any additional setup. Learn more about creating an account with Canvas here. 

Updating Scopes

As our ASSISTments Canvas integration evolves, we may require additional API endpoints to function correctly  —whether it's to pull grades, create assignments, or sync user data. These capabilities are controlled through scopes. Our team will send out an email when scopes need to be updated, and you can utilize the directions below to help you update the necessary scopes.

1. Click the pencil icon to edit.
2. Scroll to the Scopes section.
3. Add the updated scopes requested by ASSISTments
4. Save your changes. 

‍

If you still need help, email support at: contact@assistments.org