搜索

启用ManageBac+公共 API 以进行集成

The Faria Team
  • 更新

ManageBac+公共 API

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

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

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

设置 > 开发 > API 管理器 > 添加新令牌
导航至 API 管理器，创建和管理ManageBac+公共 API 令牌。

概述

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

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

关键概念/最新动态

支持的字段和函数

从左侧菜单打开“参考文档”选项卡，即可查看有关设置 API 连接的详细指南，包括示例请求和响应的说明。此页面顶部还包含一个版本下拉菜单，您可以根据不同的 API 版本选择可用的请求。

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

API 权限

对于权限字段，您可以选择“无” ，仅选择具有只读权限的字段，或选择“全部” 。您也可以通过勾选复选框来选择单个字段。

学生

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

父母

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

教师

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

年级组

  • 指数
  • 顾问
  • 学生
  • 添加学生
  • 移除学生
  • 学期出勤率
  • 日期出席情况

课程

  • 指数
  • 展示
  • 学生
  • 添加学生
  • 移除学生
  • 学期出勤率
  • 日期出席情况

课堂评估

  • 学期成绩

会员资格

  • 指数

学校

  • 展示
  • 学年
  • 主题
  • 成绩

任务

  • indexshowstudents

API 函数

年级组

  • 获取所有年级组信息
  • 获取顾问
  • 为某一年级招收学生
  • 将学生添加到年级组
  • 将学生从年级中移除
  • 获取某一年级和某一学期的班级出勤率。
  • 获取指定日期某一年级班级的出勤情况

课程

  • 获取所有课程
  • 参加课程
  • 为课程招募学生
  • 将学生添加到班级
  • 将学生从班级中移除
  • 获取课程任务
  • 获取课堂任务
  • 获取学生对某项任务和课程的评估结果
  • 获取课程的学期成绩
  • 获取一个学期内某门课程的所有成绩
  • 在学期期间统计课程出勤率
  • 获取某天的课堂出勤率

会员资格

  • 获取所有会员资格

学生

  • 获取所有学生
  • 获取学生
  • 创建新学生
  • 更新学生
  • 存档学生
  • 取消学生档案

教师

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

父母

  • 让所有家长都参与进来
  • 找个家长
  • 创建新父级
  • 更新家长信息
  • 存档家长
  • 取消存档父级

学校

  • 获取学校详情
  • 获取学年
  • 获取学校成绩
  • 获取学校科目

公用事业

  • 平
  • 获取头像

API 变更日志

您可以在ManageBac+中查看 API变更日志，方法是依次点击“设置”>“开发”>“API 管理器” 。在该页面底部，您会找到“变更日志”部分，其中按时间顺序列出了最近的 API 更新，包括新增字段、添加或修改的端点以及其他相关的技术变更。

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

逐步导航

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

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

编辑或管理 API 令牌

  1. 打开设置 > 开发 > API 管理器。
  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 。

利率限制

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

常见问题解答

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

如果产品未在“设置”>“集成”>“合作伙伴”下列出，则表示双方没有正式合作关系。在这种情况下，您的学校仍然可以通过使用公共 API 来建立自定义集成。

ManageBac+支持团队能否为我们学校构建集成方案？

请告诉我们您希望将哪个系统与ManageBac+集成，我们将考虑作为一家公司和一款产品，与该工具或服务建立直接合作伙伴关系对我们公司和产品而言是否有意义。

ManageBac+技术支持能否帮我们编写API请求？

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

ManageBac+ API 的速率限制是多少？

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

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

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

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

请发送电子邮件至 api@managebac.com ，详细说明您的请求和遇到的错误。

总之

  • ManageBac+公共 API 允许学校通过管理员管理的令牌将ManageBac+与外部系统连接起来。
  • 您可以从“设置”>“开发”>“API 管理器”创建、查看、编辑、禁用和删除令牌。
  • 参考文档、权限、API 说明、变更日志详情和常用支持指南均可在 API 管理器工作流程中找到。

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

Share

这篇文章有帮助吗？

17 人中有 10 人觉得有帮助