本指南解释了如何在SchoolsBuddy中设置和管理 API 访问权限。此过程允许您的技术团队通过 OAuth 2.0 进行身份验证，并开始将您的外部系统连接到SchoolsBuddy 。

访问这些设置需要特定权限；请确保您以组织超级管理员身份登录后再继续操作。

概述

公共 API 管理器区域仅供组织超级管理员管理。您可以在此中心枢纽创建、编辑和保护用于学校数据集成的客户端。

关键概念

在开始设置之前，请确认已满足以下先决条件：

• 您已以组织超级管理员身份登录。
• 您已准备好技术文档，可以配置必要的权限和范围。

分步导航

技巧与最佳实践

• 测试环境：在连接到您的正式SchoolsBuddy实例之前，请务必在测试环境中测试您的集成（如果可用）。
• 批量操作：在执行批量写入操作之前，请仔细阅读技术文档，以确保数据完整性。
• 凭证维护：在 API 管理器中，您可以编辑权限、重新生成凭证或禁用/删除客户端以维护安全性。

警告和重要提示

安全访问： API 凭证可让您访问学校的大量数据。请确保只有授权人员拥有超级管理员权限来管理这些设置。

公开共享：切勿公开共享您的客户端密钥；这些凭证与您的SchoolsBuddy实例唯一关联，并提供对您的数据生态系统的直接访问。

相关文章

• SchoolsBuddy公共 API 简介

常见问题解答

如果我丢失了客户端密钥会发生什么？

出于安全考虑， SchoolsBuddy不会再次显示客户端密钥。您需要使用 API 管理器为该客户端重新生成凭据。

我可以限制 API 的功能吗？

是的。在配置过程中，您可以定义特定的权限和范围，以便仅授予该特定集成所需的必要读取（GET）或写入（POST/PUT）访问权限。

总之

• 通过“设置 API 管理器”访问 API 管理器。
• 通过创建具有特定权限范围的新客户端来生成凭据。
• 安全地存储客户端 ID 和密钥，切勿公开分享。

您的SchoolsBuddy集成现已准备就绪，可以开始同步数据了。