Introduction
As mentioned in the API Primer, adding an API integration greatly improves the experience FeedbackFruits can offer a teacher.
Unlike LTI tools, API can only be enabled for a top level account. For more details see also the Canvas documentation.
Configuration
- Go to the Admin, select your account and click Developer Keys
2. Click + Developer Key
3. Fill out the fields:
Key name: FeedbackFruits
Owner email: [email protected]
For the Redirect URI (Legacy) and Redirect URIs fields:
Replace {identifier} with {environment}_{institution}. eg. test_gothamuniversity, acceptance_starfleetacademy or production_hogwarts.
When using FeedbackFruits hosted in Europe:
https://accounts.feedbackfruits.com/identify/{identifier}/callback
When using FeedbackFruits hosted in Australia:
https://au-accounts.feedbackfruits.com/identify/{identifier}/callback
When using FeedbackFruits hosted in United States:
https://us-accounts.feedbackfruits.com/identify/{identifier}/callback
4. Click Save Key
5. Send the ID, Key, URL of your environment and identifier to your FeedbackFruits contact. (Clicking Show Key might be necessary to reveal the key)
Scopes
FeedbackFruits supports the enabling of API scoping in Canvas when adding a Developer Key. To enable scopes, turn on the Enforce Scopes switch and select the following scopes:
Assignment groups
url:GET|/api/v1/courses/:course_id/assignment_groups
url:GET|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id
Assignments
url:GET|/api/v1/courses/:course_id/assignments
url:GET|/api/v1/courses/:course_id/assignments/:id
url:POST|/api/v1/courses/:course_id/assignments
Calendar Events
url:POST|/api/v1/calendar_events
url:GET|/api/v1/calendar_events/:id
url:PUT|/api/v1/calendar_events/:id
url:DELETE|/api/v1/calendar_events/:id
Courses
url:GET|/api/v1/courses/:id
url:GET|/api/v1/courses/:course_id/users
url:GET|/api/v1/courses/:course_id/users/:id
Enrollments
url:GET|/api/v1/courses/:course_id/enrollments
url:GET|/api/v1/sections/:section_id/enrollments
Group Categories
url:GET|/api/v1/group_categories/:group_category_id
url:GET|/api/v1/courses/:course_id/group_categories
url:GET|/api/v1/group_categories/:group_category_id/groups
Groups
url:GET|/api/v1/groups/:group_id
url:GET|/api/v1/courses/:course_id/groups
url:GET|/api/v1/groups/:group_id/memberships
url:GET|/api/v1/groups/:group_id/memberships/:membership_id
Modules
url:GET|/api/v1/courses/:course_id/modules
url:GET|/api/v1/courses/:course_id/modules/:id
url:POST|/api/v1/courses/:course_id/modules
url:GET|/api/v1/courses/:course_id/modules/:module_id/items
url:GET|/api/v1/courses/:course_id/modules/:module_id/items/:id
url:POST|/api/v1/courses/:course_id/modules/:module_id/items
Rubrics
url:GET|/api/v1/courses/:course_id/rubrics
url:POST|/api/v1/courses/:course_id/rubrics
url:PUT|/api/v1/courses/:course_id/rubrics/:id
Sections
url:GET|/api/v1/sections/:id
url:GET|/api/v1/courses/:course_id/sections
Submissions
url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
Users
url:GET|/api/v1/users/:user_id/profile