...
This guide colleges with an overview of the Canvas DW Direct Connect implementation process and the preparatory steps required for colleges to successfully access their Canvas API data in the CCC Data Warehouse.
...
California Community Colleges that have adopted Canvas CMS may request to implement the Canvas DW Direct Connect service through Enabling Services at the CCC Technology Center. To get started, colleges must meet the following prerequisites and complete the instructions below.
...
To participate (opt-in), send an email to Enabling Serviceswith the following subject line: Request for Canvas DW Direct Connect at [college].
The College Relationship Manager (CRM) will process your request and pass your interest to the Enabling Services Implementation team who will work with your college to facilitate the Canvas to Data Warehouse setup process.
| Note |
|---|
Data Security: For security reasons, access to the CCC Data Warehouse must be requested and managed by the Institutional Research, Planning, and Effectiveness (IRPE) lead at each college and district (as authorized by the department VP, when the IRPE lead is not the VP). IRPE requests should be submitted to your CRM at Enabling Services at the CCC Technology Center. |
...
Step 2: Generate Your Canvas API Credentials
In order to make access your Canvas Data accessible data in the CCC Data Warehouse, your data must be added using the Canvas Data API - which requires the unique will be used to add your college’s Canvas data to the DW pipeline. This process requires your unique Canvas Data API credentials (API key and secret) in the format that works with the structure of your Canvas account.
...
College Canvas Administrator
Generate the following your Canvas Data API credentials in your Canvas Admin Portal:the Admin section of the Canvas Data Portal. The API credentials will
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
To generate your college Canvas Data API credentials, a Canvas Administrator must log into the Canvas Data Portal and
Once generated, the Canvas Administrator will be provided a screen with their API Key and Secret, as shown below.
...
| Tip |
|---|
Read More: How do I obtain an API access token in the Canvas Data Portal? |
| Note |
|---|
The Way Canvas API Credentials Work |
Step 3: Copy, Store, and Safely Pass
...
Canvas API Credentials in a Secure Manner
...
Once your Canvas API credentials are generated, store a copy of these credentials in a secure manner for future reference.
Provide your API key and secret values to your ES Implementation engineer in the format below. These values should only be passed using a secure method such as Privnote.
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
Once received, your ES Implementation engineer will initiate the configuration process of adding your Canvas data into the CCC Data Warehouse.
| Note |
|---|
Once your API credentials are received, the DW data pipeline will be configured to securely pass your Canvas Data to the CCC Data Warehouse. Following initial configuration, your data will be updated nightly. |
Step 4: Work with Implementation Team to Test Access
...
| Tip |
|---|
Information for Colleges to obtain their Canvas API key and secure admin credentials |
Support FAQs
Q. How do I obtain an [Canvas] API access token in the Canvas Data Portal?
A. Colleges can review this page for instructions and other information related to their custom API access token.
...