Breadcrumbs

D2L Brightspace API Integration

Introduction

Welcome to the HelioCampus D2L Brightspace API Integration Guide. This document provides step-by-step instructions for configuring the integration between HelioCampus Assessment & Credentialing and D2L Brightspace using API standards and completing the HelioCampus Assessment & Credentialing LMS Information Form.

HelioCampus D2L Brightspace OAuth 2.0 App

A D2L Brightspace OAuth 2.0 App is required to enable HelioCampus to retrieve data from D2L Brightspace for use in HelioCampus Assessment & Credentialing.

You can also see the full list API calls made by HelioCampus Assessment & Credentialing here, D2L Brightspace REST API Calls

Generating a OAuth 2.0 App

A D2L Brightspace Administrator must generate an API Developer Key within the institution's D2L Brightspace instance by following these steps:

1. Navigate to External Learning Tool Settings

  1. Log into D2L Brightspace as an Admin.

  2. Click the Admin Tools (gear icon) in the top right.

  3. Under Organization Related, select Manage Extensibility.

  4. Click OAuth 2.0 then select the Register an app.

2. Configure the OAuth 2.0 App

In the OAuth 2.0 App dialog, enter the following details:

Note: Replace <HelioCampus_URL> with your institution’s HelioCampus Assessment & Credentialing URL.

Field

Value

Application Name

This is the key name only Admins see, we suggest, HelioCampus API Integration

Redirect URI

https://<HelioCampus_URL>/index.cfm/page/AefisLmsIntegration.authCallback

Scope

core:*:* enrollments:enrollment:read grades:gradeobjects:read quizzing:access:read quizzing:attempts:read quizzing:quizzes:read datasets:bds:read

Access Token Lifetime

72000

Description

HelioCampus is a web-based assessment management solution that facilitates the collection and application of real-time assessment data.

Prompt for user consent

Check this box.

Enable refresh tokens

Check this box.

I accept the Non-Commercial Developer Agreement

Check this box.

3. Save the OAuth 2.0 App

  1. Click Register.

4. Copy OAuth 2.0 App

  1. Locate the Client ID and copy it.

  2. Paste the Client ID into the API Developer Key field on the HelioCampus Assessment & Credentialing LMS Information Form.

  3. Locate the Client Secret and copy it.

  4. Copy the Client Secret and paste it into the API Developer Secret field on the HelioCampus Assessment & Credentialing LMS Information Form.

  5. Click Submit on the HelioCampus Assessment & Credentialing LMS Information Form.

HelioCampus D2L Brightspace Service Account

This section outlines the steps to create a service account for REST API calls between D2L Brightspace environment and HelioCampus Assessment & Credentialing. This integration enables HelioCampus to gather necessary data for assessment purposes. The following steps must be completed by a D2L Brightspace Administrator and a HelioCampus Institutional Admin at your institution.

1. Create a Service Role in D2L Brightspace

Create an Account Role that grants the service account the necessary permissions.

1. Navigate to Roles and Permissions

  1. Log into D2L Brightspace as an Admin.

  2. Click the Admin Tools (gear icon) in the top right.

  3. Under Security, select Roles and Permissions.

  4. Click Create/Copy

  5. Click Start Fresh

  6. In the Role dialog, enter the following details:

Field

Value

Name

HelioCampus Service Role

Description

Role for HelioCampus Service Account

Enable Cascading Role

Check this box.

Role Alias

HelioCampus Service Role

Tool Behavior Options

Leave all options unchecked.

Classlist Display Options

Leave all options unchecked.

Course Access Options

Access

Access inactive courses

Leave unchecked.

Access past courses

Check this box.

Access future courses

Leave unchecked.

Sections

Choose None of the above.

Groups

Choose None of the above.

  1. Click Save.

  2. In the Role Interactions dialog, enter the following details:

Role Interaction

Permission(s)

Search for 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to search for users of the service role in all org unit types.

Impersonate 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to impersonate users of the service role in all org unit types.

Enroll 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to enroll users of the service role in all org unit types.

Role Switch 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to role switch the service role in all org unit types.

See External Email Addresses for 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to view external email addresses for users of the service role in all org unit types.

See Internal Email Addresses for 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to view internal email addresses for users of the service role in all org unit types.

Make ePortfolio Content Available to 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to provide ePortfolio content to users of the service role in all org unit types.

See Parent Child Relationships for 'HelioCampus Service Role'

Allow at a minimum your Super Administrator and members of the role itself to be able to view parent child relationships for users of the service role in all org unit types.

  1. Click Save.

  2. Find the HelioCampus Service Role on the Role List page.

  3. Click the chevron next to HelioCampus Service Role, select Edit Permissions.

  4. In the Role Interactions dialog, enter the following details:
    You’ll need to grant specific permissions across several tools to allow HelioCampus Assessment & Credentialing to perform the necessary REST API calls using this role.

    Below is a list of tools and the corresponding permissions that need to be enabled.

    To complete this:

    1. Select each tool under Filter by Tool

    2. Click Apply Filter

    3. Enable the appropriate permission(s)

    4. Click Save

    5. Repeat these steps for each tool listed below.

Tool

Permission(s)

OrgUnit


Assignments

See and Manage Assignment Submission Folders

Enable at Organization & Course Offering levels

View Submitted Files

Enable at Organization & Course Offering levels

View Feedback

Enable at Organization & Course Offering levels

Rubrics

See Rubrics

Enable at Organization & Course Offering levels


Classlist

Has Access to the Classlist

Enable at Organization & Course Offering levels

See Classlist Report

Enable at Organization & Course Offering levels

View Group Enrollments

Enable at Organization & Course Offering levels


Content

View Course Content

Enable at Organization & Course Offering levels

Search Content

Enable at Organization & Course Offering levels

View Content that is Not Released

Enable at Organization & Course Offering levels


Grades

See the Grades tool

Enable at Course Offering levels

Export Grades

Enable at Course Offering levels

See user grade values (API Only)

Enable at Course Offering levels

Org Unit Editor

Can Create and Edit Org Units

Enable at Organization level


Quizzes

View Quizzes

Enable at Organization & Course Offering levels

See Stats for Any Quiz

Enable at Organization & Course Offering levels

View Quiz Setup

Enable at Organization & Course Offering levels

Grade Submitted Quizzes

Enable at Organization & Course Offering levels



User Information Privacy

See First Names

Enable at Organization & Course Offering levels

See Last Names

Enable at Organization & Course Offering levels

See Usernames

Enable at Organization & Course Offering levels

See Org Defined IDs

Enable at Organization & Course Offering levels

See Email Addresses

Enable at Organization & Course Offering levels

Users

View User Enrollments

Enable at Organization & Course Offering levels

Search for: At a minimum add the role the students are included in, this is typically the Learner role

Enable at Organization & Course Offering levels

Brightspace Data Sets

Can access Brightspace Data Sets

Enable at Organization level

  1. Click Save and Close.

2. Create the Service Account in D2L Brightspace

Create an account in D2L Brightspace, the type of account should follow your institution’s policies.
Ensure that the account setup follows the same format as other user accounts (e.g., if user login includes an email address and SIS ID, the service account should follow the same format).

  1. Log into D2L Brightspace as an Admin.

  2. Click the Admin Tools (gear icon) in the top right.

  3. Under User Related, select Users.

  4. Click New User.

  5. In the Create User dialog, enter the following details:

Field

Value

Org Defined ID

heliocampusserviceaccount

First Name

HelioCampus D2L

Middle Name

Leave blank.

Last Name

Service Account

Email

This does not need to be a real email, we suggest heliocampusserviceaccount@<YOUR INSTITUTION EMAIL DOMAIN>.edu

Send Creation Email

Uncheck this box.

Role

Click the drop-down and select HelioCampus Service Role.

Username

heliocampusserviceaccount

Password

Check Manually set password then create a strong password for the service account and be sure to securely record it

Active

Check Make user active

  1. Click Save.

Create the Service Account in HelioCampus Assessment & Credentialing

To integrate the service account you created in D2L Brightspace with HelioCampus Assessment & Credentialing, follow these steps.

This step should be completed by one of your institution’s HelioCampus Assessment & Credentialing Institutional Admins.

  1. Log into your institution’s HelioCampus Assessment & Credentialing

  2. Click the hamburger menu in the top left corner.

  3. Scroll down to the Admin Tools section of the menu.

  4. Click on User Accounts Manager.

  5. Click + ADD NEW USER in the top right corner.

  6. Choose Local User Account.

  7. Fill in the User Details with the service account information from D2L Brightspace.

Field

Value

User First Name

HelioCampus D2L

User Last Name

Service Account

User University ID

heliocampusserviceaccount

User username

heliocampusserviceaccount

User email address

The email you created in D2L Brightspace for the service account.

Enter a strong password

Create a strong password for the service account and be sure to securely record it, as you will need it later during the API authorization process

Re-enter the password

Re-enter the password

  1. Click + ADD ROLE

  2. Click the Select a role category drop-down menu, select General.

  3. Click the Select a role category drop-down menu, select Institutional Admin.

  4. Click the Select one or more Institutions drop-down menu, select your institution.

  5. Click ADD ROLE.

  6. Click SAVE NEW USER

Once all steps are completed, return to the main D2L Brightspace guide to finalize the integration.