ManageBac+パブリック API を使用して他のシステムに接続します。 API トークンを作成および管理し、サポートされているフィールドと権限を見つけます。
ManageBac+パブリック API の仕組み、API トークンの作成および管理方法、サポートされているフィールド、関数、権限、メモ、および変更ログ情報の場所を学びます。
ManageBac+パブリック API を使用すると、学校はManageBac+アカウントをManageBac+と直接統合されていない外部プラットフォームに接続できます。
これらの設定を構成できるのは、学校のアカウントの管理者だけです。このガイドでは、セットアップ、トークン管理、サポートされている機能、技術的なメモ、権限、およびよくある質問について説明します。
概要
ManageBac+パブリック API は、サードパーティ システムとのカスタム接続を構築する必要がある学校向けに設計されています。 API アクセスは、管理者によって作成および管理されるトークンによって制御されます。
API Manager から、トークンの作成、権限の制御、トークンのステータスの確認、リファレンス ドキュメントへのアクセス、API 変更ログの表示を行うことができます。
「設定」 > 「開発」には 2 つの API マネージャーが追加されました。 API Manager (Legacy)このガイドで説明されている API トークンを作成します。 API Manager (OAuth2)は OAuth2 資格情報を発行します。接続しているシステムがサポートしているものを使用してください。
主要な概念 / 新機能
サポートされるフィールドと関数
左側のメニューから[リファレンス ドキュメント]タブを開くと、サンプル リクエストとレスポンスのメモを含む、API 接続の設定に関する詳細なガイダンスが表示されます。このページには、上部にバージョンのドロップダウンも含まれているため、さまざまな API バージョンに対してリストされている利用可能なリクエストを使用できます。
API権限
権限フィールドについては、 [なし]を選択するか、読み取り専用権限を持つもののみを選択するか、 [すべて]を選択できます。チェックボックスをオンにして、個々のフィールドを選択することもできます。
学生
- 索引
- 見せる
- 作成する
- アップデート
- アーカイブ
- アーカイブを解除する
両親
- 索引
- 見せる
- 作成する
- アップデート
- アーカイブ
- アーカイブを解除する
教師
- 索引
- 見せる
- 作成する
- アップデート
年グループ
- 索引
- アドバイザー
- 学生
- 生徒を追加する
- 生徒を削除する
- 学期出席
- デート・出席
クラス
- 索引
- 見せる
- 学生
- 生徒を追加する
- 生徒を削除する
- 学期出席
- デート・出席
授業の評価
- 成績学期-成績
メンバーシップ
- 索引
学校
- 見せる
- 学年
- 科目
- 成績
タスク
- インデックスショー学生
API関数
年グループ
- すべての年のグループを取得する
- アドバイザーを取得する
- 学年グループの生徒を獲得する
- 学生を学年グループに追加する
- 学年グループから生徒を削除する
- 年間グループと学期のホームルームへの出席を取得する
- 指定した日付の学年グループのホームルーム出席を取得する
クラス
- すべてのクラスを取得する
- クラスを取得する
- クラスに生徒を参加させる
- クラスに生徒を追加する
- クラスから生徒を削除する
- クラスのタスクを取得する
- クラスのタスクを取得する
- タスクとクラスの生徒の評価結果を取得する
- クラスの学期成績を取得する
- 学期中にクラスのすべての成績を取得する
- 学期中の授業への出席を取得する
- 日付のクラスへの出席を取得する
メンバーシップ
- すべてのメンバーシップを取得する
学生
- すべての生徒を取得
- 生徒を獲得する
- 新しい生徒の作成
- 学生を更新する
- 学生をアーカイブする
- 学生のアーカイブを解除する
教師
- すべての教師を取得
- 先生を雇う
- 新しい教師を作成する
- 教師を更新する
両親
- すべての親を取得
- 親を取得する
- 新しい親の作成
- 親を更新する
- 親をアーカイブする
- 親のアーカイブを解除する
学校
- 学校の詳細を取得する
- 学年を取得する
- 学校の成績を取得する
- 学校の科目を取得する
公共事業
- ピン
- アバターを入手
API変更ログ
ManageBac+で API変更ログを表示するには、 [設定] > [開発] > API Manager (Legacy)に移動します。このページの下部には、 「変更ログ」セクションがあり、新しいフィールド、追加または変更されたエンドポイント、その他の関連する技術的な変更を含む、最近の API 更新が時系列でリストされます。
ステップバイステップのナビゲーション
ManageBac+パブリック API を有効にしてトークンを追加する
- [設定] > [開発] > API Manager (Legacy) > [新しいトークンの追加]に移動します。
- 「新しいトークンの追加」をクリックします。
- トークンの用途を簡単に識別できるように、明確で有用なトークン名を入力します。
- 生徒、保護者、教師のデータ、IB グループ、クラス、学校設定など、更新および取得するポイントを選択します。
- 「トークンの追加」をクリックしてトークンを生成します。
APIトークンを編集または管理する
- [設定] > [開発] > API Manager (Legacy)を開きます。
- クリップボード アイコンを使用してトークンをコピーし、別の信頼できるシステムで使用します。
- iアイコンの上にマウスを移動すると、トークンの権限が表示されます。
- トークンのステータスを確認して、有効か無効かを確認します。
- 「編集」をクリックして権限を調整するか、トークンを無効または有効にします。
- 統合が必要なくなったら、ゴミ箱アイコンを使用してトークンを削除します。
警告と重要な注意事項
セキュリティ警告
API トークンは、信頼できる関係者とのみ共有してください。 API トークンは、SSL 暗号化を使用せずに電子メールで送信したり、フォームに保存したりしないでください。統合が使用されなくなったら、削除アイコンをクリックして API トークンを無効にすることをお勧めします。
API ノート
- Null 値は決してレンダリングされません。
- NULL 値はPOSTリクエストでは無視されます。
- 空の文字列値は無視されず、既存の値が上書きされます。
- 一括割り当て用のユーザー (たとえば、 parent_idsまたはchild_ids )が見つからない場合、呼び出しはエラーを返します。
- インデックスアクションで使用できるパラメータは、 ANDロジックを使用してスタックされます。削除してもレコード変更タイムスタンプは変更されないため、 modified_sinceとdelete_since を同時に使用すると、予期した結果が返されない可能性があります。
- 管理者ロールを持つユーザーは、セキュリティ上の理由から API を介して読み取り専用になります。
- すべてのタイムスタンプ フィールドは ISO8601 形式です (たとえば、 2017-11-06T04:35:00.000GSTなどのyyyy-mm-ddThh:mm:ss.sssTZ)。
- API について質問や懸念がある場合は、 api@managebac.comまでお問い合わせください。
レート制限
API リクエストの制限は、同じ IP アドレスからのリクエストは 1 分あたり 200 件です。
よくある質問
ManageBac+は別のプラットフォームと統合されますか?
製品が[設定] > [統合] > [パートナー]にリストされていない場合は、正式な関係はありません。このような場合でも、学校はパブリック API を使用してカスタム統合を確立できる可能性があります。
ManageBac+ Support は私たちの学校の統合を構築できますか?
どのシステムをManageBac+と統合したいかをお知らせください。会社および製品として、そのツールまたはサービスの直接パートナーになることが理にかなっているかどうかを検討させていただきます。
ManageBac+サポートは API リクエストを作成できますか?
ManageBac+サポート チームは API の質問や問題に関するガイダンスを提供できますが、すべての API リクエストは学校が直接完了する必要があります。カスタム接続を確立している場合は、IT 部門に問い合わせてください。
ManageBac+ API のレート制限とは何ですか?
API リクエストの制限は、同じ IP アドレスからのリクエストは 1 分あたり 200 件です。
ManageBac+パブリック API の使用方法に関するガイダンスはどこで入手できますか?
各フィールドの詳細と最新の変更ログのメモについては、 「設定」 > 「開発」 > 「リファレンス ドキュメント」を参照してください。
API リクエストに問題があります。誰に連絡すればよいですか?
リクエストと発生しているエラーの明確な詳細を電子メールでapi@managebac.comに送信してください。
要約すれば
- ManageBac+パブリック API を使用すると、学校は管理者が管理するトークンを介してManageBac+外部システムに接続できます。
- [設定] > [開発] > API Manager (Legacy)からトークンを作成、確認、編集、無効化、削除できます。
- リファレンス ドキュメント、権限、API ノート、変更ログの詳細、および一般的なサポート ガイダンスはすべて API Manager ワークフロー内で利用できます。
ManageBac+ API アクセスを安全に保ち、許可に基づいて維持しながら、カスタム統合を構築するための制御された方法を学校に提供します。