Labster Help Center

For Students For Instructors For Others
More other articles
LMS Setup

(Admin) How to configure the Labster tool via Canvas API

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

  1. Go to Admin → Institution's Account → Developer Keys

  2. Click the + Developer Key button

  3. Select +API Key (🔴 do NOT select LTI Key)

    Configuring the API Developer Key

  4. 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 (🔴please make sure that your Canvas matches the exact same scope).

    Click on the name of the scope to see the drop-down and select the following:

Scope Category

Scope

Tick the boxes

COURSES

1.
url:GET|/api/v1/courses

2. url:GET|/api/v1/courses/:id

3. url:GET|/api/v1/courses/:course_id/users

ASSIGNMENTS

1. url:GET|/api/v1/courses/:course_id/assignments

2. url:POST|/api/v1/courses/:course_id/assignments

3.
url:PUT|/api/v1/courses/:course_id/assignments/:id

4.
url:DELETE|/api/v1/courses/:course_id/assignments/:id

SUBMISSIONS

1.
url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

2. url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

USERS

1.
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)

b. From the Canvas instance

Redirect URI

The URL domain that your Canvas instance uses

Please do not hesitate to reach out to our support team if you have any questions or are in need of assistance

Contact Labster Support 💻