Get Started Building an Integration

Document created by rh0068002 on Feb 26, 2018Last modified by rh0068002 on Apr 4, 2018
Version 2Show Document
  • View in full screen mode

Get Started Building an Integration

Blackboard offers a suite of education technology tools, both software and hardware. How you build an integration with Blackboard software and hardware depends on which tools you want to integrate with.

 

Before You Get Started

Blackboard offers lots of tools to help you develop an application, plugin, or other integration for use with Blackboard products like Blackboard Learn and Blackboard Collaborate. The most important ones are your accounts with these sites:

  • Blackboard Developer Portal is where you register applications so they can work with Blackboard products. It's also where you get your own key and secret that you need to authenticate your application with Blackboard products.
  • Blackboard Developer Community is where you learn to develop with Blackboard products, get the latest news, and discuss with other Blackboard integrators.

 

Register as a Blackboard Developer

Before you can authenticate your project with Blackboard applications, you need to be a registered Blackboard developer.

 

To register as a Blackboard developer:

  1. Go to https://developer.blackboard.com/ and select Sign Up. Read and agree to the terms and conditions.
  2. Provide your email address, a password, your first name and last, and select the checkbox to prove you are human.
  3. Select Create Account and you're on your way.

 

Join the Community

The Blackboard developer community is the best place to find more information about integrating your project with Blackboard products. You will benefit from the community most by joining in.

 

To register in the Blackboard developer community:

  1. Go to Blackboard Developer Community and select Register.
  2. If your organization is a Blackboard client or partner organization and you have a Behind the Blackboard login, select Behind the Blackboard Login. Otherwise, select Community Site Login.
  3. Enter your email address to receive a link via email.
  4. In your email's inbox, find the email sent by Blackboard. You might have to check your spam or junk folder. The email's subject is something like Blackboard Community: Email Validation. Select the link in your email. You will be taken to a registration page.
  5. In the registration page, complete all the required fields and select Create Account.

 

What Blackboard Application Do I Need?

Your Blackboard-compatible application can work with one or more of Blackboard's tools. How you build an integration with Blackboard software and hardware depends on which tools you want to integrate with. The tools you'll want to use depend on what you want to do.

I want to programmatically...You'll need to...
add files, text, and the like to Blackboard Learn
  1. authenticate with Blackboard Learn via REST API
  2. check out our Learn REST API reference

bulk add users to Blackboard Learn

  1. authenticate with Blackboard Learn via REST API
  2. check out our Learn REST API reference
set up video conference sessions
  1. authenticate with Blackboard Collaborate via REST API
  2. check out our Collaborate REST API reference
invite users to video conference sessions
  1. authenticate with Blackboard Collaborate via REST API
  2. check out our Collaborate REST API reference
get a list of users who attended a video conference session
  1. authenticate with Blackboard Collaborate via REST API
  2. check out our Collaborate REST API reference

 

Get Development Instances of Blackboard Applications

Blackboard makes available instances of Blackboard applications that you can use to build projects that integrate with Blackboard applications. Among others, we offer these popular developer instances. Blackboard does not charge a fee for entry-level use.

For more information about developer versions of Blackboard applications, see Developer Versions of Blackboard Applications in the community site (did you sign up yet?).

 

Authenticate Your Project with Your Blackboard Application

Different Blackboard applications have different constraints and requirements. How you authenticate varies a bit between application.

 

Check Out Sample Applications

Different Blackboard applications have different constraints and requirements. How you authenticate varies a bit between application.

 

Look at the REST Reference for Your Application

The REST references will guide you while you work with Blackboard applications.

 

Let Us Know How It's Going

If you have a question that isn't answered already, try searching. If that doesn't get you the results you need, ask the community a question. You can also write a blog post to start a conversation or show off an achievement. If you have an idea for something that might benefit the APIs or the documentation or community, definitely submit an idea to let us know. If you get really stuck, email developers@blackboard.com.

1 person found this helpful

Attachments

    Outcomes