Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.33 KB

README.md

File metadata and controls

24 lines (13 loc) · 1.33 KB
Raw

The goal of this repository is to provide small examples of Canvas API usage along with pointing out some security best practices.

API Scripts

API Scripts should primarily be used for automating regular tasks, running occasional one offs, or possibly collecting data for research purposes. The bottom line is that they should generally not require to much user input/action. If your task does require a large amount of user input/action, consider building a web application instead.

API Script Security Guidelines

The two most import security considerations are to ensure that Canvas access tokens are secure and that any data collected by the script is secure.

Scripts MUST follow these guidelines:

  • Access tokens MUST never be stored in the scripts or repositories.
  • Access tokens MUST never be stored, distributed, or displayed in any way by a script.
  • Access tokens MUST be treated as a password when being entered via user input.
  • Data collected MUST follow UBC's data security guidelines. If in doubt, get in touch with UBC's LTHub for clarification and help.

API Example Scripts

Python Example Scripts

JavaScript Example Scripts - TODO