Learn REST Integrations Tool for System Administrators
You have (or someone else has) built or found this great Blackboard Learn REST Application that you want to make accessible to the Blackboard Community, but how do you make it available so that they can link to it?
This is accomplished by making the Application ID available to System Administrators who can then configure access to your Application using the REST Integrations tool located on the Learn System Admin panel in the Building Blocks section:
REST API Integrations Tool
The main page for the REST API Integrations tool:
1) Lists existing integrations,
2) Allows you to manage existing integrations, and
3) Allows you to create new integrations
This list will be empty if you have not created any integrations.
Creating an Integration
Clicking the Create Integration link opens the page that allows you to define and save a REST Integration. On this page you:
1) enter the REST Application ID as provided by the developer/vendor and
2) the Learn User with the entitlements required by the REST Application. (See below Converting Documented Entitlements to GUI Privileges)
The Learn User entitlements are what constrains or establishes the limitations of the REST application in your Learn environment. The best practice is to set these to be as restrictive as necessary while still allowing for the REST Application to function. The entitlements information should be provided by the Vendor that gave you the REST Application ID. You should never configure a REST Application with a System Admin User.
Managing your REST Integration
Once created you may manage your REST integration much as you would any other integration you may:
1) Edit the integration settings
2) Set the integration availability
3) Delete the integration
Editing a REST Integration
The Editor displays information about the integration and allows for changing the Learn User which the Integration runs as. This allows you to set the permissions on the integration:
You may use the standard Learn User and Role tools to create an integration specific user and apply the appropriate privileges for that user's role to enable the execution of the REST actions required by the integration. The privileges required by an integration should be provided by the developer in their documentation or when they provide the Learn Administrator with the Application ID. If a vendor requests that you provide a System Administrator user for their application, do not do so and provide that vendor's contact and application information to email@example.com.
Running an Integration
An integration is run in two ways. In both cases the application is remote to the Learn environment:
1) via a link within Learn which calls the remote application
2) via a remote system call either from a command line or graphical user interface such as in a browser, or on a computer, tablet or cell phone.
Sample code for REST demos is covered in documents in the Examples section.
Converting Entitlements to GUI Privileges
The below EntitlementsToAdminGUI worksheet provides the means to identify the REST API specified entitlements to a string which may be searched on in the role privilege selection page when creating the role for your REST Application user. Paste the documented entitlement from the REST API documentation to column A and the Privilege will appear in column B.