| Info |
|---|
This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff. |
...
From the Admin section of your Canvas application:
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. Copy API Credentials: Copy the API Key and API SecretA success notification with your API credentials will display.
...
(Above 4. Copy API Credentials: Once you’ve created your API credentials , a ‘success’ notification box will display your are created, copy the API Key and API Secret values.) 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. |
5. Create New API Credentials: You can create new credentials by clicking the Create Credentials button.
| Note |
|---|
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. |
...
Generate your Canvas Data API credentials in 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]
...
Once generated, the Canvas Administrator will be provided a screen with their API Key and Secret, as shown below.
| Tip |
|---|
| Tip |
Read more creating your Canvas API credentials: How do I obtain an API access token in the Canvas Data Portal? |
...
Step 3:
...
Safely Pass Your Canvas API Credentials
...
Once your Canvas API credentials are generated, store a copy of these credentials in a secure manner for future reference.
...
to CCC Technology Center
To facilitate the process of adding your Canvas data into the Data Warehouse, safely pass 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 Upon receipt of your API values, your ES Implementation engineer will initiate facilitate the configuration process of adding your Canvas data into the CCC Data Warehouse with the CCCTC DevOps team.
| Note |
|---|
Once With your API credentials are receivedvalues in place, the DW data pipeline will be is configured to securely pass your Canvas Data data to the CCC Data Warehouse. Following initial configurationAfter that, your Canvas data will be updated nightly. |
| Tip |
|---|
Learn More about the Canvas Data API and the Canvas DW Direct Connect service. |
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. |
Step 4: Work with Implementation Team to Test Access
...
| Tip |
|---|
Information for Colleges to obtain their Canvas API key and secure admin credentials |
...
FAQ: Canvas DW Direct Connect Service
Q. What is the Canvas Data API?
...
A. Yes, however to revoke access for a user, the Canvas Admin user will need to regenerate the credentials and securely distribute the credentials again.
| Note |
|---|
The Way Canvas API Credentials Work |
Q. How do I obtain an [Canvas] API access token in the Canvas Data Portal?
...