ManageBac+公開API

ManageBac+公開APIの仕組み、APIトークンの作成と管理方法、サポートされているフィールド、関数、権限、注意事項、変更履歴情報の入手先について学びましょう。

ManageBac+公開APIを使用すると、学校はManageBac+アカウントを、 ManageBac+と直接統合されていない外部プラットフォームに接続できます。

これらの設定は、学校のアカウントの管理者のみが構成できます。このガイドでは、セットアップ、トークン管理、サポートされている機能、技術的な注意事項、権限、およびよくある質問について説明します。

設定 > 開発 > APIマネージャー > 新しいトークンを追加 — APIマネージャーに移動して、 ManageBac+公開APIトークンを作成および管理してください。

概要

ManageBac+の公開APIは、サードパーティシステムとのカスタム接続を構築する必要がある学校向けに設計されています。APIへのアクセスは、管理者が作成および管理するトークンによって制御されます。

APIマネージャーからは、トークンの作成、権限の制御、トークンステータスの確認、リファレンスドキュメントへのアクセス、API変更履歴の表示が可能です。

主要概念／新機能

サポートされているフィールドと関数

左側のメニューから「リファレンスドキュメント」タブを開くと、API接続の設定に関する詳細な手順が表示されます。サンプルリクエストとレスポンスに関する注記も含まれています。このページの上部にはバージョン選択ドロップダウンがあり、さまざまなAPIバージョンに対応したリクエストを選択できます。

APIマネージャーの「参考資料」タブ — サポートされているリクエスト、サンプルレスポンス、およびバージョン固有のAPIの詳細については、「リファレンスドキュメント」タブを参照してください。

API権限

権限フィールドについては、 「なし」を選択するか、読み取り専用権限を持つフィールドのみを選択するか、 「すべて」を選択できます。また、チェックボックスをオンにして個々のフィールドを選択することもできます。

学生

索引
見せる
作成する
アップデート
アーカイブ
アーカイブ解除

両親

索引
見せる
作成する
アップデート
アーカイブ
アーカイブ解除

教師

索引
見せる
作成する
アップデート

学年別

索引
アドバイザー
学生
学生を追加する
学生を削除する
学期出席
日付出席

クラス

索引
見せる
学生
学生を追加する
学生を削除する
学期出席
日付出席

授業評価

成績・学期成績

会員制度

索引

学校

見せる
学年度
対象
成績

タスク

インデックス表示学生

API関数

学年別

全学年を取得
アドバイザーを探す
学年ごとに生徒を集める
生徒を学年グループに追加する
学年グループから生徒を削除する
学年別・学期別のホームルーム出席状況を取得する
指定した日付の学年グループのホームルーム出席状況を取得する

クラス

すべてのクラスを取得する
クラスを受講する
授業の生徒を集める
クラスに生徒を追加する
生徒を授業から退出させる
授業の課題を取得する
授業の課題を受け取る
課題とクラスに関する学生評価結果を取得する
授業の学期末成績を取得する
学期中のクラスの全成績を取得する
学期中の授業の出席状況を取得する
特定の日付の授業出席状況を取得する

会員制度

すべてのメンバーシップを取得する

学生

すべての学生を取得する
学生をゲットしよう
新しい学生を作成する
学生の最新情報
学生のアーカイブ
学生のアーカイブを解除する

教師

すべての教師を取得する
先生を雇おう
新しい教師を作成する
教師を更新する

両親

すべての親を取得する
親を捕まえる
新しい親を作成する
保護者情報を更新する
親をアーカイブする
親フォルダのアーカイブを解除

学校

学校の詳細情報を取得する
学年度を取得する
学校の成績を取得する
学校の科目を取得する

公共事業

ピング
アバターを入手

API変更履歴

ManageBac+で API の変更履歴を確認するには、 [設定] > [開発] > [API マネージャー]に移動してください。このページの下部にある[変更履歴]セクションには、新しいフィールド、追加または変更されたエンドポイント、その他の関連する技術的な変更など、最近の API の更新が時系列順に一覧表示されます。

APIマネージャーの変更履歴セクション — API Managerの変更履歴を確認して、最近のAPIの更新情報や技術的な変更点を確認してください。

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