APIドキュメント
APIテストハブ
学校のAPIキーを使って各エンドポイントを試し、システムが受け取るレスポンスをそのまま確認できます。リクエストはブラウザから直接APIに送信され、データの読み取りのみを行います。
APIキーの確認
APIキーが有効かどうかを確認し、どの学校のキーかを表示します。まずここから始めてください。
GET/smrtapi/v1/auth
エラー時の応答を確認する
個別の生徒
1人の生徒のクラス、コース、課題、評価、学習への取り組み状況をまとめて取得します。
info学習への取り組み状況のデータは6か月間保存されます。
GET/smrtapi/v1/student/{student}
エラー時の応答を確認する
生徒一覧
生徒をページ単位で取得し、それぞれの概要を表示します。クラスやコースで絞り込むことも、検索することもできます。
GET/smrtapi/v1/students
エラー時の応答を確認する
個別のクラス
1つのクラスの名簿、統計、学習への取り組み状況をまとめて取得します。
GET/smrtapi/v1/class/{class}
エラー時の応答を確認する
クラス一覧
クラスをページ単位で取得し、それぞれの概要を表示します。ステータス、コース、教師で絞り込むことも、検索することもできます。
GET/smrtapi/v1/classes
エラー時の応答を確認する
結果