Skip to content

Commit

Permalink
Add instructions for API token generation
Browse files Browse the repository at this point in the history
  • Loading branch information
schwartzpub committed Aug 29, 2022
1 parent 369015c commit a992516
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ To install the module use:
python3 -m pip install canvas-parent-api
```

### Get API Token
If you are a parent, you will have a Canvas Parent account. To get an API token, you must sign into the Canvas Parent application from a web browser. This is typically using: https://<yourdistrict>.instructure.com/login/canvas

Once you have signed into your account, navigate to Account > Settings.

Under "Approved Integrations" click "+ New Access Token" to create a new API Token.

Enter a Purpose and Expiration date (blank for no expiration).

Be sure to save your API token, as you will have to generate a new token if this is lost.

### Usage
Example usage to get students, printing names:
```python
Expand Down

0 comments on commit a992516

Please sign in to comment.