| Info |
|---|
This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff. |
...
College Canvas Administrator
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 Secret.
...
(Above: Once you’ve created your API credentials, a ‘success’ notification box will display your API Key and API Secret values.)
| 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. |
College Canvas Administrator
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]
...
Connect to the CCC Data Warehouse through your established DW Direct Connect (ODBC/JDBC) and access your Canvas Data either through your local BI application (typically Tableau or Power BI) or an SQL query.
Support FAQs
...
| Tip |
|---|
Information for Colleges to obtain their Canvas API key and secure admin credentials |
Support FAQs
...
FAQs
Q. What is the Canvas Data API?
A. The Canvas Data API allows you to get information about or download Canvas Data files.
Q. Who is authorized to access your Canvas Data API credentials?
A. Any Canvas Data Admin user can generate API credentials for your Canvas account. However, once generated, the credentials are shared between all admin users for that account. If you would like to grant access to other users or third-party partners to download files via the API, you can generate credentials and securely pass them to those users.
Q. Can access to our API credentials be revoked from specific users?
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.
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.
From the Admin link in the Canvas Data Portal navigation bar:
Open Account: Click the Admin link, then click on the name of the Canvas 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 Secret. If you return to the Credentials Portal, you will be able to see the API Key but not the API Secret.
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. |