搜索

启用 ManageBac+ 公共 API 进行集成

The ManageBac+ Team
  • 更新
Markdown
快速解答

使用ManageBac+公共 API 连接其他系统。创建和管理 API 令牌并查找支持的字段和权限。

了解ManageBac+公共 API 的工作原理、如何创建和管理 API 令牌，以及在哪里可以找到支持的字段、函数、权限、注释和变更日志信息。

ManageBac+公共 API 允许学校将其ManageBac+帐户连接到未直接与ManageBac+集成的外部平台。

只有您学校帐户的管理员才能配置这些设置。本指南涵盖设置、令牌管理、支持的功能、技术说明、权限和常见问题。

设置 > 开发 > <span class= API 管理器（旧版）> 添加新令牌">
导航到 API Manager 以创建和管理ManageBac+公共 API 令牌。

概述

ManageBac+公共 API 专为需要与第三方系统建立自定义连接的学校而设计。 API 访问通过管理员创建和管理的令牌进行控制。

从 API 管理器中，您可以创建令牌、控制权限、查看令牌状态、访问参考文档以及查看 API 更改日志。

设置>开发现在有两个 API 管理器。 API Manager (Legacy)创建本指南中描述的 API 令牌。 API Manager (OAuth2)颁发 OAuth2 凭据。使用您所连接的系统支持的系统。

关键概念/新增内容

支持的字段和函数

从左侧菜单中打开“参考文档”选项卡，获取有关设置 API 连接的详细指南，包括带有示例请求和响应的注释。此页面顶部还包含一个版本下拉列表，以便您可以使用针对不同 API 版本列出的可用请求。

API Manager 中的“参考文档”选项卡
使用“参考文档”选项卡查看支持的请求、示例响应和特定于版本的 API 详细信息。

API权限

对于权限字段，您可以选择None、仅选择具有只读权限的字段或选择All。您还可以通过勾选复选框来选择各个字段。

学生

  • 指数
  • 展示
  • 创造
  • 更新
  • 档案
  • 取消存档

父母

  • 指数
  • 展示
  • 创造
  • 更新
  • 档案
  • 取消存档

教师队伍

  • 指数
  • 展示
  • 创造
  • 更新

年级组

  • 指数
  • 顾问
  • 学生
  • 添加学生
  • 删除学生
  • 学期出勤
  • 日期出勤

课程

  • 指数
  • 展示
  • 学生
  • 添加学生
  • 删除学生
  • 学期出勤
  • 日期出勤

班级评估

  • 年级学期成绩

会员资格

  • 指数

学校

  • 展示
  • 学年
  • 科目
  • 成绩

任务

  • 索引显示学生

API函数

年级组

  • 获取所有年级
  • 获取顾问
  • 获取年级组的学生
  • 将学生添加到年级
  • 从年级中删除学生
  • 获取年级和学期的班主任出勤率
  • 获取某个年级在指定日期的班主任出勤情况

课程

  • 获取所有课程
  • 参加课程
  • 让学生参加课程
  • 将学生添加到班级
  • 从班级中删除学生
  • 获取班级任务
  • 获取班级任务
  • 获取任务和班级的学生评估结果
  • 获取班级的学期成绩
  • 在一个学期内获取班级的所有成绩
  • 在学期期间获得课程的出勤率
  • 获取约会的出勤率

会员资格

  • 获得所有会员资格

学生

  • 获取所有学生
  • 获得一名学生
  • 创建新学生
  • 更新学生
  • 存档学生
  • 取消存档学生

教师队伍

  • 获取所有教师
  • 找老师
  • 创建新教师
  • 更新老师

父母

  • 获取所有家长
  • 找个家长
  • 创建新父级
  • 更新父级
  • 归档父级
  • 取消归档父级

学校

  • 获取学校详细信息
  • 获得学年
  • 获取学校成绩
  • 获取学校科目

公用事业

  • 平
  • 获取头像

API变更日志

您可以通过导航到“设置”>“开发”> API Manager (Legacy)来查看ManageBac+中的 API更改日志。在此页面的底部，您将找到“更改日志”部分，其中按时间顺序列出了最近的 API 更新，包括新字段、添加或修改的端点以及其他相关技术更改。

API 管理器中的变更日志部分
查看 API Manager 中的更改日志以跟踪最近的 API 更新和技术更改。

逐步导航

启用ManageBac+公共 API 并添加令牌

  1. 导航到设置 > 开发 > API Manager (Legacy) > 添加新令牌。
  2. 单击添加新令牌。
  3. 输入清晰且有用的令牌名称，以便轻松识别令牌的用途。
  4. 选择您想要更新和检索的点，包括学生、家长和教师数据、IB 组、班级和学校设置。
  5. 单击“添加令牌”以生成令牌。
API 管理器导航路径
从“设置”中的“开发”部分打开 API Manager。
添加新令牌配置屏幕
选择令牌名称并选择创建令牌之前所需的权限。

编辑或管理 API 令牌

  1. 打开“设置”>“开发”> API Manager (Legacy)。
  2. 使用剪贴板图标复制令牌以在另一个受信任的系统中使用。
  3. 将鼠标悬停在i图标上可查看令牌权限。
  4. 查看令牌状态以查看它是启用还是禁用。
  5. 单击“编辑”以调整权限或禁用或启用令牌。
  6. 当不再需要集成时，使用垃圾桶图标删除令牌。
具有复制、编辑和删除操作的现有 API 令牌
通过复制、查看、编辑、启用、禁用或删除现有令牌来管理它们。

警告和重要说明

安全警告

您的 API 令牌只能与受信任的各方共享。 API 令牌切勿通过电子邮件发送或保存在未经 SSL 加密的表单上。一旦不再使用集成，我们建议通过单击删除图标来禁用 API 令牌。

API 令牌控制，包括删除选项
确保令牌安全，并在不再需要时将其删除。

API注释

  • 永远不会呈现空值。
  • POST请求中的空值将被忽略。
  • 空字符串值不会被忽略，并且会覆盖现有值。
  • 当找不到要进行批量分配的用户时，任何调用都会返回错误，例如Parent_ids或child_ids。
  • 可用于使用AND逻辑的索引操作堆栈的参数。同时使用modified_since和deleted_since可能不会返回预期的结果，因为删除不会改变记录修改时间戳。
  • 出于安全原因，任何具有管理员角色的用户都只能通过 API 进行只读操作。
  • 所有时间戳字段均采用 ISO8601 格式，例如yyyy-mm-ddThh:mm:ss.sssTZ，例如2017-11-06T04:35:00.000GST。
  • 如果您对 API 有疑问或疑虑，请联系api@managebac.com。

速率限制

API 请求限制为每分钟来自同一 IP 地址的200 个请求。

常见问题解答

ManageBac+是否与其他平台集成？

如果产品未在“设置”>“集成”>“合作伙伴”下列出，则不存在正式关系。在这些情况下，您的学校可能仍然能够使用公共 API 建立自定义集成。

ManageBac+支持可以为我们学校构建集成吗？

让我们知道您希望将哪个系统与ManageBac+集成，我们将考虑作为一家公司和产品，成为该工具或服务的直接合作伙伴是否有意义。

ManageBac+支持可以为我们编写API请求吗？

ManageBac+支持团队可以提供有关 API 问题的指导，但所有 API 请求必须由您的学校直接完成。如果您要建立自定义连接，请咨询您的 IT 部门。

ManageBac+ API 速率限制是多少？

API 请求限制为每分钟来自同一 IP 地址的200 个请求。

在哪里可以找到有关如何使用ManageBac+公共 API 的指南？

请参阅“设置”>“开发”>“参考文档”，了解每个字段的详细信息和最新的变更日志说明。

我的 API 请求有问题。我应该联系谁？

请发送电子邮件至 api@managebac.com，并提供有关请求和您遇到的错误的详细信息。

总之

  • ManageBac+公共 API 允许学校通过管理员管理的令牌将ManageBac+连接到外部系统。
  • 您可以从设置 > 开发 > API Manager (Legacy)中创建、查看、编辑、禁用和删除令牌。
  • 参考文档、权限、API 注释、变更日志详细信息和常见支持指南均在 API Manager 工作流程中提供。

ManageBac+为学校提供了一种构建自定义集成的受控方式，同时保持 API 访问安全且基于权限。

Share

这篇文章有帮助吗？

17 人中有 10 人觉得有帮助