SchoolsBuddyパブリックAPIのご紹介
SchoolsBuddy学校の内部システムやサードパーティシステムと安全に接続することで、ワークフローの自動化やカスタム統合を実現できます。
学校は生徒、職員、活動の管理に複数のシステムを利用するケースが増えており、データの同期を維持するには、従来、手動での再入力や個別の回避策が必要でした。SchoolsBuddy SchoolsBuddyパブリックAPIは、こうした状況を変え、学校が既に利用しているツールとSchoolsBuddy安全かつ直接的に連携させる方法を提供します。
コアとなるユーザーおよびアクティビティ管理を中心に構築されたこのAPIは、開発チームがSchoolsBuddyとプログラム的に連携するための拡張性と柔軟性に優れた方法を提供します。また、組織のスーパー管理者がアクセスを厳密に制御することで、すべての統合のセキュリティを確保しています。
概要
SchoolsBuddyパブリックAPIは、手作業によるデータ入力を削減し、学校のシステム全体でデータを同期させるように設計されています。このAPIは、大量の管理タスクを自動化したり、 SchoolsBuddy独自開発または社内構築のMIS/SISプラットフォームと統合したりする必要のある、組織のスーパー管理者や開発者などの技術チーム向けに構築されています。
新着情報
APIには、学生、連絡先、スタッフ、イベント、場所、グループ、好み、即時予約登録などのコアデータエンティティのエンドポイントが含まれています。主な機能は以下のとおりです。
- 場所管理：学校のあらゆる活動で使用する専用の場所を作成および管理します。
- データエクスポート： SchoolsBuddyアクティビティを生徒別またはイベント別にエクスポートし、他の内部システムとのシームレスな表示と統合を実現します。
- 出席管理API：イベントの出席記録をプログラムで読み書きすることで、学校全体のシステムをリアルタイムで同期させることができます。
- 外部学生登録：入学前学生、サマースクール参加者、外部課外活動参加者など、学校の学生情報システム（SIS）に登録されていない学生を追加および管理します。
- スタッフおよびファシリテーターの記録：ゲストファシリテーター、外部コーチ、旅行リーダー、地区スタッフなど、SISに登録されていない外部スタッフを管理します。
- 仮想環境との統合：学校が選択したデジタルコミュニケーションプラットフォームにおける、教師のオンライン会議IDを更新および維持します。
- 作成と管理:好みと即時予約登録、スポーツや旅行のイベントスケジュール用グループ、料金請求用グループ、保護者面談用科目クラス（他のデータインポート元がない場合にのみ必要）。
ステップバイステップナビゲーション
APIクライアントの設定
管理者設定 > 連携 > 公開API
- APIアクセスをプロビジョニングするには組織のスーパー管理者権限が必要なため、その権限でログインしていることを確認してください。
- 専用のセットアップガイドに従って、APIクライアントを登録し、認証情報を生成してください。
- 提供された認証情報を使用して、統合のためのOAuth 2.0認証を設定してください。
- 最初の呼び出しを作成する前に、Swaggerドキュメントで利用可能なエンドポイント（学生、連絡先、スタッフ、イベント、場所、グループ、サインアップ）を確認してください。
- 本番環境でのデータ同期を展開する前に、可能であれば非本番データセットを使用して統合テストを実施してください。
詳しい設定手順はこちらをご覧ください： SchoolsBuddy公開 API の設定方法。
ヒントとベストプラクティス
- セキュリティ第一：提供されているOAuth 2.0認証規格を使用して、データへの安全なアクセスを確保してください。
- ドキュメントを確認してください。開発者は、エンドポイントの仕様と認証に関するガイダンスの詳細については、 インテグレーションポータルとSwaggerページを参照してください。
- 効率性：大規模なデータセットを扱う際には、ページネーションメタデータを活用して効率的なデータ取得を実現しましょう。
警告および重要事項
関連記事
よくある質問
どのような認証方法が使用されていますか？
このAPIは、すべての連携において最新のセキュリティ基準を確保するために、OAuth 2.0認証を使用しています。
技術文書は入手可能ですか？
はい、OpenAPI/Swagger定義を含む包括的な開発者向けドキュメントは、 インテグレーションポータルから入手できます。
APIアクセスを設定できるのは誰ですか？
組織のスーパー管理者のみがAPIクライアントへのアクセスをプロビジョニングできるため、統合セキュリティが厳密に管理されます。
要約すれば
- APIは、 SchoolsBuddy社内システムまたはサードパーティシステムと接続し、データワークフローを自動化します。
- 現在、学生、職員、イベント、場所、グループ、および好みと即時予約登録に対応しています。
- アクセス権限は、組織のスーパー管理者のみがOAuth 2.0を介して付与します。
SchoolsBuddy公開APIを利用して、学校の運営効率を向上させましょう。
関連