将您的iSAMS集成更新至 OAuth 2.0(现有客户)

The Faria Team
  • 更新

受众:本文适用于目前正在使用iSAMS集成的SchoolsBuddy现有客户。

iSAMS正在将所有批量 API 升级到 OAuth 2.0——这是一个现代行业标准,可为学校数据提供增强的数据安全性、提高的连接可靠性和更好的访问控制。

为确保您的数据同步在即将到来的iSAMS断电期间不会中断,请在 2026 年 10 月 14 日之前完成以下步骤。

第一部分:在iSAMS中生成 OAuth 2.0 客户端密钥

  1. 以管理员身份登录iSAMS并打开控制面板。
  2. 选择API 服务管理器。 屏幕截图:选择 API 服务管理器
  3. 选择“管理批量 API 密钥”。 屏幕截图:选择“管理批量 API 密钥”
  4. 找到您现有的SchoolsBuddy批量 API 密钥,然后点击右侧的金色钥匙图标。
    屏幕截图:找到您现有的 SchoolsBuddy 批量 API 密钥,然后点击右侧的金色钥匙图标。
  5. 在弹出的窗口中,询问您是否要为此 API 密钥创建新密钥,单击“是” 。 屏幕截图:在弹出的窗口中,询问您是否要为此 API 密钥创建新密钥,请单击“是”。
  6. 将显示客户端 ID 和客户端密钥。
    ⚠️重要提示:在完成第二部分之前,请勿关闭此窗口或浏览器标签页! 屏幕截图:将显示客户端 ID 和客户端密钥。

第二部分:将您的凭据添加到SchoolsBuddy

以超级管理员身份登录SchoolsBuddy 。

  1. 前往“设置”
  2. 入门 > 数据集成屏幕截图:入门 > 数据集成
  3. 确认“导入启用”开关已设置为“开启”(绿色)。
  4. 请确认您学校的iSAMS主机 URL 是否正确。 截图:确认您学校的 iSAMS 主机 URL 是否准确

  5. 滚动到 API 密钥部分(所有活动数据实体都应该已经启用)。

  6. 请核对您的客户 ID(此字段应已预先填写)。

  7. 将您在第 1 部分(步骤 6)中生成的客户端密钥粘贴到相应的字段中。
    截图:将您在第一部分(步骤 6)中生成的客户端密钥粘贴到相应的字段中。

  8. 家长导入筛选条件:这些筛选条件是在初始导入阶段根据您学校的偏好设置的。除非您学校的导入要求发生了变化,否则请保留这些设置不变。

  9. 教职工导入筛选条件:您学校的电子邮件域名已在此处添加。除非您正在更新教职工域名,否则请勿更改此部分。
  10. 年末处理:您现在无需在此处进行任何更改。当您的年度学分结转时,请参阅我们的[ iSAMS年末处理指南] 。
  11. 滚动到页面底部,然后单击“保存更改”。 屏幕截图:滚动到页面底部,然后单击“保存更改”。

您的iSAMS集成现已更新,并为即将到来的 OAuth 2.0 迁移做好准备!

🚀 新功能:手动触发iSAMS导入

现在您可以直接在SchoolsBuddy中手动触发从iSAMS按需导入数据!如果您在iSAMS中进行了紧急更改,并且需要立即在SchoolsBuddy中反映这些更改:

  1. 转到“设置” > “入门” > “数据集成” 。

  2. 点击页面底部的“运行导入”按钮。

⏱️ 关于手动导入的重要说明:

  • 速率限制:运行导入按钮每5 分钟只能触发一次。

  • 处理时间:根据学校规模和数据集的大小,导入过程可能需要10 到 20 分钟才能完成。

  • iSAMS数据源刷新延迟:为了使更新内容显示在SchoolsBuddy中,更改必须首先同步到iSAMS API 数据源。直接在您的iSAMS实例中更新数据并不意味着SchoolsBuddy的数据源会立即更新。请等待iSAMS刷新其数据源后再触发导入操作。

  • 专业提示:您可以通过缩短 API 密钥缓存过期时间来缩短iSAMS数据源的更新频率。(默认值:24 小时)

    截图:专业提示:您可以通过缩短 API 密钥缓存过期时间来缩短 iSAMS 数据源的更新频率。
Share

这篇文章有帮助吗?

1 人中有 1 人觉得有帮助