Skip to main content

Building Block 和 REST API

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

为什么使用 REST API？

开发人员使用 REST API 可以创建只松散耦合到 Blackboard 服务器的应用程序。它们可以位于任何地方。它们允许服务器提供信息，而不会产生可能对服务器造成干扰的风险。

使用 REST API 提高安全性

REST API 可以在各种安全模式下运行。 Blackboard

重要

最佳实践是，授予集成用户使用集成工具所需的最低权限，而不是完全系统管理员权限。

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

您可以通过开发人员门户请求访问 Blackboard REST API。一旦您注册了应用程序，我们将生成一个唯一的密钥和密令，以便您可以拨打电话并获取将您的应用程序与我们的平台相集成所需的数据。例如，基于 REST 的应用程序可以访问：

  • 公告

  • 课程

  • 内容

  • 附件

  • 作业

  • 成绩

如需了解开发人员可用的 REST 端点的完整列表，请参阅Anthology REST API 文档。您还可以详细了解 Anthology REST API 框架并查找有关使用 REST API 的第一步的信息。

注册 REST 集成在 Blackboard

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

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

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

  2. 选择创建集成。

  3. 在应用程序 ID 中，输入通过在 Anthology 的开发人员门户上注册应用程序所提供的应用程序 ID。

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

  5. 对于第三方集成，请将终端用户访问设置为是。终端用户将使用自己的 Blackboard ID 登录使用集成。这样，每个用户的访问权限都限制为他或她自己的权限。如果您将终端用户访问设置为否，则集成始终具有表单上所指示的 Blackboard 用户的访问权限。

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