Introduction

As mentioned in the API Primer, the API integration greatly improves the user experience for teachers using FeedbackFruits.

The Blackboard integration consist of 2 separate APIs. Both a REST API integration and a SOAP API integration are required to set up the integration. Both integrations use a service account.

This article includes images from an older Blackboard release, your styling may vary slightly.

Configuring the REST API

Set up the service account

1. Go to System admin, then click Users

2. Click Create User
3. Fill out the required fields as you wish
4. Give this user the Goal Performance Viewer system role
FeedbackFruits needs the permission to lookup users. By default this system role has this permission, while minimizing other access.
5. Click Submit

Enable the REST API integration

1. Go to System admin, then click REST API integrations

2. Click Create Integration
3. Fill out the fields
Application ID: d9f15e80-3b76-4fdc-b568-9fa3be92fccc
Learn User: The user you just created

4. Click Submit

Configuring the SOAP API

Enable the Web Services

1. Go to System Admin, then click Web Services

2. Select:

  • Context.WS
  • Course.WS
  • CourseMembership.WS
  • User.WS
  • Util.WS

Hover over Availability, click Make Available

3. Select:

  • Context.WS
  • Course.WS
  • CourseMembership.WS
  • User.WS
  • Util.WS

Hover over Discoverability, click Make Discoverable.

4. Restart your Blackboard cluster, this propagates the changes made to the web services to all instances. This can be done manually or by waiting a couple of days to have the auto restart take care of it.

Enable the proxy tool registration

1. Go to System admin, click Building blocks

2. Click Proxy Tools
3. Click Manage Global Properties
4.
Ensure Allow Unknown Proxy Tools and Expose Tool Consumer Profile are checked.
5. Send the Proxy Tool Registration Password to your FeedbackFruits contact along with the hostname of your Blackboard instance. It may be empty.

Enable the proxy tool

You should wait until you receive word from FeedbackFruits that the tool was successfully registered before continuing.

1. Go to System admin, click Building blocks

2. Click Proxy Tools
3. Hover over fbf and click the arrow, click Edit

4. Review the settings, set Availability to Yes, click Submit

You'll receive word from your FeedbackFruits contact to let you know if everything is working.

Did this answer your question?