Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
bgColor#FFFAE6

NOTE: This CCC Data Warehouse user guide provides support and implementation steps for the Canvas Data 1.0 direct access service exclusively for California Community Collegesdocument pertains to Canvas 1.0 - currently being replaced with Canvas Data 2 from Instructure.
For information on integrating your college’s Canvas Data 2 API with the CCC Data Warehouse Direct Connect Service, see CCC Data Warehouse - Direct Access User Guide.

...

Introduction

This guide provides colleges with an overview of the implementation process and preparatory steps required for colleges to successfully access their Canvas data in the CCC Data Warehouse.

...

  1. Open Your Account: Click the Admin link in your Canvas application, then click on the name of your account or sub-account.

  2. Open Canvas Data Portal: In Account Navigation, click the Canvas Data Portal link.

  3. 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?

...

  1. 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.

    1. 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.)

    2. 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.)

  2. 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.

...