As an administrator, you play a crucial role in ensuring a smooth integration of the Labster tool into your learning management system. We will provide you with step-by-step instructions, tips, and best practices to successfully set up and optimize the Labster tool within your Canvas environment.
Prerequisites
You must have Administrator credentials for the Canvas installation to be able to set up the Labster tool.
You must have received the Redirect URI from your Labster Implementation Specialist. This is the URI that you will need to apply on step 4 of the registration process.
Step-by-step instructions
Creating an API Developer Key in Canvas
Go to Admin → Institution's Account → Developer Keys
Click the + Developer Key button
Click on the
+ Developer Keybutton, then select+API Key.
🔴 Note: Do not select+LTI Key.
Configuring the API Developer Key
You can now configure a Labster Developer Key by following the next steps:
a) Enter a Key Name: Labster (This will only be the name of the developer key; The tool name will be determined by another field)
b) Enter the Redirect URI provided by your Labster representative in the previous step
c) Client Credentials Audience: Peer Service
d) Enforce Scopes: CHECKEDMARKED
*This is just an example of a redirect URI. Depending on your geographical region, your redirect URI may be different.
e) Enforce the following scopes (🔴ensure that the scopes configured in your Canvas exactly match the required ones).
Click on the name of the scope to see the drop-down and select the following:
COURSES
url:GET|/api/v1/coursesurl:GET|/api/v1/courses/:idurl:GET|/api/v1/courses/:course_id/users
ASSIGNMENTS
url:GET|/api/v1/courses/:course_id/assignmentsurl:POST|/api/v1/courses/:course_id/assignmentsurl:PUT|/api/v1/courses/:course_id/assignments/:idurl:DELETE|/api/v1/courses/:course_id/assignments/:id
SUBMISSIONS
url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_idurl:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
USERS
url:GET|/api/v1/users/:user_id/profile
5. Once you enforce all scopes you can click on the Save button
Activating the API Developer Key
6. Set the State of the key from “OFF” (red) to “ON” (green)
7. Share the developer key details with your Labster representative
Kindly ensure the retrieval of the 4 following details. These are necessary for the LMS tool registration process.
a. From the Developer key
Client ID (the digits under details)
Client Secret (Click on Show Key under Details)
Redirect URI
b. From the Canvas instance
The URL domain that your Canvas instance uses
Creating a placement for the Labster tool
a. Go to Admin → Settings → Apps → View App Configurations
b. Select +App
c. On the Add App screen, select:
Configuration Type: By URL
Name: Labster (This will be the name shown in the courses)
Config URL: Enter the URL provided by your Labster Implementation Specialist
d. Click Submit
Congratulations!🎉
Congratulations on successfully registering the Labster tool via Canvas API! To ensure that the tool has been configured properly, we kindly request you add a simulation to a course and access it using a student account. This will help verify the functionality of the tool. 👇
Please do not hesitate to reach out to our Support Team if you have any questions or need assistance.
To get in touch with our Support Team, you can:
🔵click on the blue button located at the bottom right of the screen
📚 Help Center article Contact Support
📧 or by email: customer.support@labster.com