API updates - Blackboard Premium APIs

Blackboard Learn SaaS Continuous Delivery v3900.6.0 | Release to Production 4 February 2021
Ultra Experience

Premium APIs: In this release, Blackboard’s Premium APIs transition from technical preview to general availability. Blackboard Premium APIs are REST-based application interfaces that add capabilities and value for institutions, partners, and other third-party tool creators beyond simple data exchange and available open standards. The first set of available Premium APIs is a collection called the Ultra Extension Framework (UEF) APIs.

The UEF APIs allow an integrated tool to communicate securely with Learn. With the UEF, integrated tools are aware of where users are in Learn and what they’re interacting with. The UEF is typically used with standards such as LTI Advantage to integrate a tool’s user interface and REST APIs to exchange data. The UEF allows a tool to engage with users when and where they need to rather than hoping that users visit fixed tool locations. Institutions and third parties who use the UEF will have the opportunity to create more personalized experiences in Blackboard Learn than can be achieved in other learning platforms.

The UEF enhances Learn’s Ultra Base Navigation and Ultra Course View with a robust set of capabilities:

  • Real-time telemetry provides detailed user navigation behavior information so integrated apps can respond in very personalized ways.
  • Help provider registration allows the default behavior of the Learn Ultra help tool (the question mark bubble icon) to be overridden with another support solution.
  • User interface element rendering gives integrated applications the ability to populate UI elements and content, including banners, modals, interface panels, and notifications to users only when and where they’re needed, creating unique and tailored experiences for each user.

For more information on the UEF, please refer to https://docs.blackboard.com/learn/uef/getting-started

 

Using Premium APIs: During technical preview, we handled access to Premium APIs manually for early access participants. Now that they are generally available, access is formally managed in the Developer Portal. Appropriate Developer Groups can give designated applications access to Blackboard’s Premium APIs. Premium APIs are not directly visible to, or usable by, end users.

Blackboard’s Premium APIs, including the Ultra Extension Framework, are available to all clients and Blackboard Partnership Program members at the Bronze level and higher. Developers who want to use Premium APIs must have configured their Developer Portal Groups accordingly. Please, contact Support with your request or send an email to [email protected] if you have additional questions. Visit the Blackboard Partners page for more information about partnership levels.
 

Examples of the use UEF: 

  • Qwickly is leveraging the UEF (a Premium API) to provide instructors the option to display the attendance Check-in entry tool from directly within the Ultra course experience. This enhanced integration results in fewer clicks and eliminates the reliance on an external tool launch. 
  • EesySoft uses Premium APIs to deliver a highly personalized user experience based on where the user is and what they’re currently doing within the Learn Ultra application.