このガイドでは、 SchoolsBuddyで API アクセスを設定および管理する方法について説明します。この手順により、技術チームは OAuth 2.0 を介して認証を行い、外部システムをSchoolsBuddyに接続できるようになります。

これらの設定にアクセスするには特定の権限が必要です。続行する前に、組織のスーパー管理者としてログインしていることを確認してください。

概要

パブリックAPIマネージャー領域は、組織のスーパー管理者のみが管理できます。この中央ハブでは、学校のデータ統合に使用するクライアントを作成、編集、保護することができます。

主要概念

セットアップを開始する前に、以下の前提条件が満たされていることを確認してください。

• あなたは組織のスーパー管理者としてログインしています。
• 必要な権限とスコープを設定するための技術文書は準備できています。

ステップバイステップナビゲーション

ヒントとベストプラクティス

• ステージング環境：可能であれば、本番環境のSchoolsBuddyインスタンスに接続する前に、必ずステージング環境で統合テストを実施してください。
• 一括書き込み操作：データの整合性を確保するため、一括書き込み操作を開始する前に技術文書を十分に確認してください。
• 認証情報の管理： APIマネージャー内で、セキュリティを維持するために、権限の編集、認証情報の再生成、クライアントの無効化/削除を行うことができます。

警告および重要事項

セキュリティアクセス： API認証情報は、学校のデータへの重要なアクセス権限を付与します。これらの設定を管理できるスーパー管理者権限は、承認された担当者のみに付与されるようにしてください。

公開共有：クライアントシークレットを絶対に公開しないでください。これらの認証情報は、お客様のSchoolsBuddyインスタンスに固有のものであり、お客様のデータエコシステムへの直接アクセスを提供します。

関連記事

• SchoolsBuddyパブリックAPIの概要

よくある質問

クライアントシークレットを紛失した場合、どうなりますか？

セキュリティ上の理由から、 SchoolsBuddyクライアントシークレットを再度表示しません。そのクライアントの認証情報を再生成するには、APIマネージャーを使用する必要があります。

APIの機能を制限することはできますか？

はい。設定時に、特定の統合に必要な読み取り（GET）または書き込み（POST/PUT）アクセスのみを付与するように、特定の権限とスコープを定義できます。

要約すれば

• 設定 > API マネージャーから API マネージャーにアクセスしてください。
• 特定のスコープを持つ新規クライアントを作成して、認証情報を生成します。
• クライアントIDと秘密情報は安全に保管し、決して公開しないでください。

SchoolsBuddyとの連携が完了し、データの同期を開始できるようになりました。