受講履歴取得API
この機能はテスト運用中です。
「受講履歴取得API」では、各講座（情報セキュリティ講座、研究データ管理講座、自機関限定コース）の受講履歴を取得できます。
本機能が想定するユーザは、各機関の機関管理者（コース管理者）です。
APIを利用するには、機関ごとに発行されるトークンが必要となり、学認LMS の管理画面からトークンを発行します。
トークンの有効期限は1年で、 有効期限の2週間前に「[GakuNin LMS] トークン有効期限のお知らせ」というメールが代表者に届きます。
APIは適切なエンドポイントに HTTP POST リクエストを発行することにより動作するよう設計されています。
本機能を第２版にアップデートし、これまで取得できた「受講レポート」に加え、「インタラクションレポート」「活動完了レポート」「コース完了レポート」「コースバッジ授与状況」「コース情報」が取得できるようにいたしました。
※ 第１版：2023年３月公開（２機能）、第２版：2024年10月公開（７機能）
（第１版では (1)指定コースに対するコースモジュールIDの取得 (2)指定したコースモジュールIDに関する受講履歴の取得 を提供していました）
本APIでは、以下の機能 (APIメソッド)を提供しております。
各APIメソッドで出力される情報は「APIリファレンス」を参照ください。
各APIメソッドのリクエスト形式は API利用者に提供される「利用者マニュアル」に掲載しています。
(1) コースモジュールidの取得
第１版の「指定コースに対するコースモジュールIDの取得」と同等の機能です。
(2) 受講レポートの取得
第１版の「指定したコースモジュールIDに関する受講履歴の取得」と同等の機能です。
リクエスト時のパラメータを第２版では若干変更しておりますので、ご注意ください。
(3) インタラクションレポートの取得 【新機能】
SCORM コースモジュールの受講情報を取得できます。
情報セキュリティ講座のコース管理者が取得できていたものを APIで取得できます。
※ 2024年10月現在、情報セキュリティ講座の評点の一部に不具合がございます。
(4) 活動完了レポートの取得 【新機能】
コース内のモジュールに活動完了設定が行われている場合に、 活動完了レポートを取得できます。
(5) コース完了レポートの取得 【新機能】
コースにコース完了設定が行われている場合に、コース完了 レポートを取得できます。
(6) コースバッジ授与状況の取得 【新機能】
コース上で授与された各種バッジの状況を確認できます。
例えば、情報セキュリティ講座の活動完了バッジ (ウェルカム/満点/コンプリート)や、研究データ管理講座のコース完了バッジの授与状況を確認できます。
(7) コース情報の取得 【新機能】
各コースの基本設定や、コース完了情報の取得可否、コースで提供される バッジの一覧を確認できます。
申込方法
- 本機能は、機関単位で代表者1名（コース管理者）にお申込みいただく機能です。
代表者には、機関ごとに発行されるトークンの管理をしていただきます。
※同一機関において複数部局での利用希望がある場合、機関内で代表部局を決めていただきますようお願いいたします。
お申込みにあたり、以下の3種類からご利用される機能を選択（複数選択可）ください。
代表者には、カッコ内のオプション機能にお申込みいただいていることが利用条件となりますので、お申込みされていない場合は利用申請をお願いいたします。
・情報セキュリティ講座 受講履歴取得API （情報セキュリティ講座の受講履歴取得機能）
・研究データ管理講座 受講履歴取得API （研究データ管理講座の受講履歴取得機能）
・自機関限定コース 受講履歴取得API （自機関限定コース作成機能）
- 先行利用実施要領 をご確認の上、ご同意ください。
- 学認LMSサポート担当まで所属機関の学認LMS連絡担当者からメールでご連絡ください。
その際、メールの件名は「【先行利用申込】受講履歴取得API」としてください。
他のオプション機能の先行利用を同時にお申し込みいただく場合も、1つの機能につき1件のメールをお送りください。
メールでは以下の内容をあわせてお知らせください。
（代表者氏名、招待メール送付先メールアドレスは、コース管理者と同一でお願いします。）
コース管理者のアカウントは個人のePPNとひもづくため、個人の氏名、個人で使用するメールアドレスでの申請をお願いいたします。
・機関名
・代表者氏名
・代表者所属
・招待メール送付先メールアドレス
・利用する機能（３種類から選択）
- お申し込み後、およそ1週間の間に学認LMSサポート担当よりグループへの入会のご連絡を差し上げます。
入会処理の詳細は、「mAP Core上のグループへの入会」の項目をご覧ください。
- グループへの入会を確認いたしましたら、API機能を利用するための利用者マニュアルを提供いたします。
利用者マニュアルには、履歴取得のための curlコマンド例を記載しております。
利用者マニュアルに沿って、学認LMS上で履歴取得API用のプラグインで、APIアクセスのためのトークンをご自分で発行してください。
このトークンを用いて、ご希望いただいたコースに関する学習履歴を WebAPIにより取得いただけます。
mAP Core上のグループへの入会
本機能をご利用いただくには、学認クラウドゲートウェイサービス上のグループ機能であるmAP Core（エムエーピーコア）で管理されているグループに入会いただく必要があります。
オプション機能の申込をすると、学認クラウドゲートウェイサービスから、件名『[GakuNinCloudGS] 招待メール』というメールが届きます。
メール本文中の一番下に、<グループ入会URL>が記載されており、クリックすると学認クラウドゲートウェイサービスのログイン画面が表示されますので、必ず所属機関名を選択し、ログインしてください。
学認クラウドゲートウェイサービスにOrthrosでログインしてしまうと、グループに入会しても学認LMSでオプション機能は利用できません。
学認クラウドゲートウェイサービスにOrthrosでログインした状態で招待メールのURLをクリックすると、自動的にOrthrosでグループに入会してしまう仕様です。
招待メールのURLをクリックする前に、Orthrosで学認クラウドゲートウェイサービスにログインしていないことをご確認ください。
Orthrosで学認クラウドゲートウェイサービスにログインしている場合、一度ログアウトして所属機関IdPでログインし直してから、招待メールのURLをクリックするようお願いいたします。
ログインすると、GakuNinLMS_GradesAPIグループへの入会画面が表示されますので、条件に同意の上、チェックボックスにチェックいただき、入会をクリックします。
「GakuNinLMS_GradesAPIに入会しました。」と表示され、入会が完了します。
なお、学認LMSまたは学認クラウドゲートウェイサービスへの最終ログインから2年間ご利用がないアカウントは、オプション機能がご利用できなくなりますのでご注意ください。
参考資料
2024年度 第1回 学認SP研究会 ライトニングトーク 資料
学認LMS 受講履歴取得APIの改版
LC4RIのノートブック上でのAPI操作