Canvas Data API Guide

Document created by lfeng@instructure.com on Sep 8, 2015Last modified by jivedocs@instructure.com on Jan 9, 2016
Version 6Show Document
  • View in full screen mode

Canvas Data provides the ability to retrieve data downloads via an API.

The Canvas Data API is different from the existing Canvas APIs and are only used to get information about or download data files for Canvas Data.  For details on how to use the Canvas Data api to retrieve flat files, please see https://portal.inshosteddata.com/docs/api

 

If you would like to grant access to other users or third-party partners to automatically download data, you can generate API credentials and pass them to those users. The API Key and Secret can be generated by any admin who is a Canvas Data Administrator. These credentials are shared for all users, so if you need to revoke a user's access, you will need to regenerate the credentials and distribute them again.

 

To generate the credentials, open Account Navigation in Canvas and click the Canvas Data Portal link.

 

In the Credentials Portal, scroll to the bottom of the page to the API Credentials section. Click the Create Credentials button.

 

Screen Shot 2015-07-29 at 2.36.05 PM.png

 

Once the credentials are generated, you will need to save them and transmit them securely to the users or 3rd party partners that will need them.

Screen Shot 2015-07-29 at 2.36.09 PM.png

Once you return to the Credentials Portal, the Portal will remind you that you've already generated API credentials. The credentials can be regenerated at any time but the old credentials will be invalidated.

Screen Shot 2015-07-29 at 2.36.26 PM.png

2 people found this helpful

Attachments

    Outcomes