学校越来越依赖多个系统来管理学生、教职工和各项活动，而以往保持这些数据同步往往意味着手动重新录入或采用定制化的变通方案。SchoolsBuddy 公共 API SchoolsBuddy推出改变了这一现状，为学校提供了一种安全、直接的方式，将SchoolsBuddy与他们已使用的工具连接起来。

该 API 以核心用户和活动管理为核心，为开发团队提供了一种可扩展、灵活的方式来以编程方式与SchoolsBuddy进行交互，组织超级管理员严格控制访问权限，以确保每次集成的安全。

概述

SchoolsBuddy公共 API 旨在减少手动数据录入，并确保学校生态系统内的数据同步。它专为技术团队（通常是组织超级管理员及其开发人员）而设计，方便他们自动化批量管理任务，或将SchoolsBuddy与自定义或内部构建的 MIS/SIS 平台集成。

什么是新的

该API包含核心数据实体的接口，包括学生、联系人、教职工、活动、地点、群组、偏好设置和即时预订注册。主要功能包括：

• 地点管理：创建和管理可在学校所有活动中使用的专用地点。
• 数据导出：按学生或事件导出SchoolsBuddy活动，以便与其他内部系统无缝显示和集成。
• 考勤 API：以编程方式读取和写入活动考勤记录，以保持整个学校生态系统实时同步。
• 校外学生注册：添加和管理学校学生信息系统 (SIS) 中未包含的学生，例如预录取学生、暑期学校学员或校外拓展课程参与者。
• 员工和辅导员记录：管理 SIS 中未找到的外部人员，包括客座辅导员、外部教练、旅行领队或地区工作人员。
• 虚拟集成：更新和维护教师在学校选择的数字通信平台上的在线会议 ID。
• 创建和管理：偏好和即时图书注册、体育或旅行活动安排组、收费组以及家长教师会议科目课程（仅当您没有其他数据导入源时才需要）。

分步导航

设置您的 API 客户端

管理员设置 > 集成 > 公共 API

1. 请确认您已以组织超级管理员身份登录，因为此角色是配置 API 访问权限所必需的。
2. 请按照专门的设置指南注册您的 API 客户端并生成凭据。
3. 使用提供的凭据为您的集成配置 OAuth 2.0 身份验证。
4. 在构建第一个调用之前，请查看 Swagger 文档中提供的端点（学生、联系人、员工、活动、地点、群组、注册）。
5. 尽可能在正式推出实时数据同步之前，使用非生产数据集测试您的集成。

完整的设置说明请参见此处： 如何设置SchoolsBuddy公共 API 。

技巧与最佳实践

• 安全第一：使用提供的 OAuth 2.0 身份验证标准，以确保安全访问您的数据。
• 查阅文档：开发人员应查阅集成门户和Swagger 页面，以获取完整的端点规范和身份验证指南。
• 效率：处理大型数据集时，利用分页元数据可以高效地检索数据。

警告和重要提示

相关文章

• 如何设置SchoolsBuddy公共 API
• 管理组织超级管理员权限

常见问题解答

使用哪种身份验证方法？

该 API 使用 OAuth 2.0 身份验证，以确保所有集成均符合现代安全标准。

是否有技术文档？

是的，完整的开发者文档，包括 OpenAPI/Swagger 定义，可通过集成门户获取。

谁可以设置 API 访问权限？

只有组织超级管理员才能配置 API 客户端访问权限，从而严格控制集成安全性。

总之

• 该 API 将SchoolsBuddy与内部或第三方系统连接起来，以实现数据工作流程的自动化。
• 目前涵盖学生、教职工、活动、地点、团体、偏好和即时预订注册。
• 访问权限仅由组织超级管理员通过 OAuth 2.0 授予。

使用SchoolsBuddy公共 API 提升学校的运营效率。