1. Using LTI for launching the tool
Qwickly Attendance, Course Tools and Jot are installed in your LMS (Blackboard Learn/Canvas/Desire2Learn Brightspace) as an LTI 1.3 tool. This LTI 1.3 connection is simply used as a launching point for Qwickly from your LMS, and most subsequent communication between Qwickly and your LMS is done through your LMS's REST APIs.
- Qwickly only takes the following values from the initial LTI launch request: the requesting LMS's domain, the LMS ID of the course from where the link was opened and the current user's LMS ID
2. Using REST APIs to Communicate with the LMS
Qwickly follows a 3-Legged OAuth workflow with your LMS to generate an API token for the user who is using Qwickly. This process enables the LMS to authenticate the identity of the logged-in user and generate an API token on their behalf which will be used by Qwickly. This token is used by Qwickly on the logged-in user's behalf to load information from the LMS (such as user information, course information, enrollment information, etc.)
- If a user has a previously existing token/session with Qwickly from the same browser, Qwickly will have cached some data from the previous session and may bypass making certain requests (such as reloading a course's enrollments if that information was already cached beforehand)
- Each API token generated from an LMS lasts for approximately 60 minutes. So, if a user has been running Qwickly continuously for more than 60 minutes, they may notice that certain actions such as the gradebook integration may not be working as expected (since the API token will have expired). If this is the case, the user can simply close the Qwickly window and relaunch Qwickly from the LMS, at which point the tool should refresh and update the API token
Almost all of Qwickly's REST API requests to the LMS are GET requests.
If grading is enabled, then Qwickly Attendance may do POST/PUT/DELETE requests to your LMS
- POST/PUT requests would be made to create or update attendance grades recorded from Qwickly Attendance into the LMS
- DELETE requests would be made if an existing grading integration within Qwickly Attendance was turned off
- If grading settings are turned on, Qwickly Attendance makes these API requests to your LMS after attendance has been taken. In the event that an API token fails, the updated grades from Qwickly Attendance may not show correctly. This article explains what to do in such a case.
Last edited: Changed 1.1 to 1.3, and included all Qwickly products.
Comments
0 comments
Please sign in to leave a comment.