Blackboard 提供对一套 REST API 的公共访问,这些 API 使开发人员可以创建访问 Blackboard Learn 的自定义应用程序。
要详细了解我们的集成合作伙伴,请访问 Anthology 应用程序目录。
为什么使用 REST API?
开发人员使用 REST API 可以创建仅松散耦合到 Blackboard Learn 服务器的应用程序。它们可以位于任何地方。它们允许服务器提供信息,而不会产生可能对服务器造成干扰的风险。
使用 REST API 提高安全性
REST API 可以在各种安全模式下运行。Blackboard REST API 授权使用行业标准 OAuth 2.0。该标准支持根据 Blackboard Learn 管理员定义的权限发出请求。此外,应用程序可以使用协议的三足变体。此方法将应用程序验证为特定的 Blackboard Learn 用户,而不共享用户的凭据。用户登录以允许应用程序代表他们执行操作。然后,应用程序仅获得该用户享有的访问权限级别。
最佳实践是,授予集成用户使用集成工具所需的最低权限,而不是完全系统管理员权限。
您可以使用 REST API 执行哪些操作?
您可以通过开发人员门户请求访问 Blackboard REST API。一旦您注册了应用程序,我们将生成一个唯一的密钥和密令,以便您可以拨打电话并获取将您的应用程序与我们的平台相集成所需的数据。例如,基于 REST 的应用程序可以访问:
- 公告
- 课程
- 内容
- 附件
- 作业
- 成绩
有关可供开发人员使用的 REST 端点的完整列表,请参阅 Learn API 文档。
在 Blackboard Learn 中注册 REST 集成
Blackboard Learn 支持集成使用 Blackboard Learn REST API 构建的外部应用程序。在使用与 Blackboard Learn 的集成之前,管理员必须先将其注册到 Blackboard Learn。
在开始注册应用程序之前,您必须获得一个应用程序 ID。开发人员可以直接将该 ID 提供给管理员,或将其与应用程序的支持文档捆绑在一起。
- 在管理员面板的“集成”下,选择 REST API 集成。
- 选择创建集成。
- 在应用程序 ID 中,输入通过在 Anthology 的开发人员门户上注册应用程序所提供的应用程序 ID。
- 在 Learn 用户旁边,选择浏览。搜索该集成应代表其执行操作的 Blackboard 用户。通常,集成充当管理员或为集成管理创建的其他用户。理想情况下,用户仅具有使集成正常运行所需的权限。
- 对于第三方集成,将最终用户访问设置为是。最终用户将使用自己的 Blackboard Learn ID 登录以使用集成。这样,每个用户的访问权限都限制为他或她自己的权限。如果您将最终用户访问设置为否,则集成始终具有表单上所指示的 Blackboard Learn 用户的访问权限。
- 选择提交以保存您的设置。