| Info |
|---|
This CCC Data Warehouse user guide provides support and implementation steps for the Canvas data direct access service, exclusively for California Community Colleges. |
...
| Note |
|---|
Strongly Recommended: For security reasons, the CCCTC recommends that a new Admin user account be created specifically for this project to prevent the API key from affecting other active Admin accounts. In the event this API key needs to be changed or disabled, other API keys would then not be affected. See Creating a New Canvas Admin User instructions below for adding a new Admin user. |
Getting Started
College must request to participate in having their Canvas data in the CCC Data Warehouse.
College will participate in the Enabling Services Implementation process, through successful setup and confirmed data access.
...
| Note |
|---|
Strongly Recommended: For security reasons, the CCCTC recommends that a new Admin user account be created specifically for this project to prevent the API key from affecting other active Admin accounts. In the event this API key needs to be changed or disabled, other API keys would then not be affected. See Creating a New Canvas Admin User instructions below. |
College Canvas Administrator
...
Open Your Account: Click the Admin link in your Canvas application, then click on the name of your account or sub-account.
Open Canvas Data Portal: In Account Navigation, click the Canvas Data Portal link.
Create API Credentials: Click the Create Credentials button. A success notification with your API credentials will display.
...
4. Copy API Credentials: Once API credentials are created, copy the API Key and API Secret and prepare to pass to the Implementation Engineer at the CCC Technology Center.
| Note |
|---|
Note: If you return to the Credentials Portal, you will be able to see the API Key but not the API Secret. |
| Tip |
|---|
Read more creating your Canvas API credentials: How do I obtain an API access token in the Canvas Data Portal? |
...
To facilitate the process of adding your Canvas data into the Data Warehouse, provide your API Key and Secret values to your ES Implementation Engineer in the format shown below. These values should be passed using a secure method such as Privnote.
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]
(Replace <misCode> with your college MIS code, and replace “apikey” with your Canvas API key value generated for your specific Instructure account.)Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
(Replace <misCode> with your college MIS code, and replace “apisecret” with your Canvas API secret value generated for your specific Instructure account.)
Upon receipt of your API values, your ES Implementation Engineer will facilitate the process of adding your Canvas data into the CCC Data Warehouse with the CCCTC DevOps team.
...
Creating New API Credentials: You can create new credentials by clicking the Create Credentials button again.
| Warning |
|---|
Important: Generating new API credentials will invalidate the old credentials for all users who have access to them. This includes third-party partner accounts, such as the CCC Data Warehouse. |
...