BlackboardHelp Center

REST API 集成

Updated on

Note

这些文档采用 AI 辅助的机器翻译。译文按原样提供,不保证其准确性。本内容的英文版本为官方权威来源。

Blackboard LMS提供对一套 REST API 的公共访问,开发人员可以使用这些 API 创建访问 Blackboard LMS 的自定义应用程序。要详细了解我们的集成合作伙伴,请访问 Blackboard 应用程序目录。

为什么使用 REST API?

开发人员使用 REST API 可以创建与 Blackboard LMS 服务器松散耦合的应用程序。这些应用程序可以位于任何位置。它们让服务器能够提供信息,而不会对服务器造成潜在干扰。

REST API 的安全性

REST API 可以在各种安全模式下运行。Blackboard LMSREST API 授权使用行业标准 OAuth 2.0。该标准支持根据 Blackboard LMS 管理员定义的权限发出请求。此外,应用程序可以使用该协议的三方(three-legged)变体。此方法将应用程序验证为特定的 Blackboard LMS 用户,而无需共享用户的凭据。用户登录以允许应用程序代表他们执行操作。然后,应用程序仅获得该用户享有的访问权限级别。

Important

最佳做法是,仅授予集成用户使用集成工具所需的最低权限,而不是完整的系统管理员权限。

您可以使用 REST API 执行哪些操作?

您可以通过开发人员门户请求访问 Blackboard REST API。注册应用程序后,我们将生成唯一的密钥和机密,以便您可以进行调用并获取将应用程序与我们的平台集成所需的数据。例如,基于 REST 的应用程序可以访问:

  • 公告

  • 课程

  • 内容

  • 附件

  • 作业

  • 成绩

有关开发人员可用的完整 REST 端点列表,请参见 Blackboard REST API 文档。您还可以详细了解 Blackboard REST API 框架,并查找有关 REST API 入门的信息。

在以下位置注册 REST 集成Blackboard LMS

Blackboard LMS支持集成使用 Blackboard LMS REST API 构建的外部应用程序。在使用与 Blackboard LMS 的集成之前,管理员必须先在 Blackboard LMS 中注册该集成。

在开始注册应用程序之前,您必须获得一个应用程序 ID。开发人员可以直接将该 ID 提供给管理员,或将其与应用程序的支持文档捆绑在一起。

  1. 在管理员面板的集成下,选择 REST API 集成。

  2. 选择创建集成。

  3. 在应用程序 ID 中,输入在 Blackboard 的开发人员门户上注册应用程序时提供的应用程序 ID。

  4. 在 Learn 用户旁边,选择浏览。搜索该集成应代表其执行操作的 Blackboard LMS 用户。通常,集成以管理员或为集成管理而创建的其他用户身份执行操作。理想情况下,该用户仅具有集成正常运行所需的权限

  5. 对于第三方集成,请将最终用户访问设置为是。最终用户将使用自己的 Blackboard LMS ID 登录以使用集成。这样,每个用户的访问权限仅限于其自身的权限。如果您将最终用户访问设置为否,则集成始终以表单上指定的 Blackboard LMS 用户的身份进行访问。

  6. 选择提交保存您的设置。

In this section