How to Set Up a Canvas Connector in Kadal
Before importing courses from Canvas into Kadal, users must first establish a secure connection between the two platforms. This is done by creating a Canvas Connector in Kadal, which enables seamless data exchange using API integration.
This article provides step-by-step instructions to configure the Canvas Connector by retrieving access credentials from Canvas, entering the required details in Kadal, and saving the connection.
Steps:
-
Retrieve Access Credentials from Canvas
- To establish the connection, users must obtain an Access Token or Developer Keys from their Canvas account.
-
-
- Log in to your Canvas admin account.
- Navigate to Developer Keys (under Admin settings).
- Generate an Access Token or retrieve Developer Keys for API integration.
- Copy the credentials securely, as they will be required in the next steps.
-
Note: If you are unsure how to obtain these credentials, refer to contact your Canvas administrator.
-
Log in to Kadal
- Go to the Kadal login page.
- Enter the LearningMate-provided credentials.
- Click "Sign In" to access the dashboard.
Note: Users who do not yet have access should contact Kadal Support for assistance.
-
Navigate to the Connectors Section
- From the Kadal Dashboard, locate and click the Connectors tab.
- Click "+ Connectors" or select the Canvas icon to open the Connector Configuration modal.
-
Configure the Canvas Connector
- In the Connector Configuration modal, enter the following details:
-
-
- Name → Assign a recognizable name for this connection (e.g., "Canvas LMS – Spring 2025").
- LMS Type → Select Canvas from the dropdown.
- Domain URL → Enter the full Canvas URL
- Connection Type → Select the appropriate connection type based on your institution’s integration model.
-
Note: The connection type cannot be modified after saving, so verify before proceeding.
-
Save the Connector
- Review the entered details.
- Click Save to finalize the setup.
- Once saved, the Canvas Connector will appear under the Connectors section, indicating that the connection has been established successfully.
The Canvas Connector is now ready. In the next step, users will import courses from Canvas into Kadal.
Best Practices
-
Use a Descriptive Connector Name
- Choose a name that identifies the connection, such as "Canvas – Spring 2025 Courses" instead of just "Canvas Connector."
- This helps differentiate multiple connectors if managing several institutions or departments.
-
Verify Canvas API Credentials
- Ensure that the Access Token or Developer Keys have the required API permissions.
- If credentials are incorrect or lack permissions, the integration may fail.
-
Confirm the Correct Canvas Domain URL
- The Canvas Domain URL should match your institution’s Canvas instance.
- Using an incorrect or partial URL can prevent Kadal from connecting to Canvas.
-
Understand Connection Types Before Selection
- Some institutions have different Canvas API configurations based on SIS integration, admin-level access, or individual course access.
- Since the Connection Type cannot be changed after saving, verify your selection before proceeding.
-
Test the Connector After the Setup
- Before moving to Step 2 (Importing Courses), confirm that the connector is active and visible under the Connectors tab.
- If the connection does not appear, check if the credentials were entered correctly and retry the setup.