1. TOP
  2. ご利用機関様へ
  3. オプション機能
  4. 受講履歴取得API

受講履歴取得API

この機能はテスト運用中です。

目次

概要
アップデート情報
お申し込み方法
mAP Core上のグループへの入会
API機能一覧
参考資料

概要

■ 対象者
各機関の機関管理者（コース管理者）
■ お申し込み方法
利用を希望される機関は、学認LMSサポート担当へメールでお申し込みください。
詳しい手順や必要事項については、本ページの「お申し込み方法」セクションをご参照ください。
■ 注意事項
  • 利用に必要なもの：APIの利用には、機関ごとに発行される「トークン」が必要です。学認LMSの管理画面から発行できます。
  • 動作の仕組み：適切なエンドポイントに対して、HTTP POST リクエストを発行することで動作します。
  • トークンの有効期限と更新：有効期限は1年間です。期限が切れる2週間前に、代表者宛てに「[GakuNin LMS] トークン有効期限のお知らせ」という通知メールが届きますので、失効前に更新手続きを行ってください。

アップデート情報

  • 2024年10月：第2版公開
    これまで取得できた「受講レポート」に加え、新たに以下の情報が取得可能になりました。
    • インタラクションレポート
    • 活動完了レポート
    • コース完了レポート
    • コースバッジ授与状況
    • コース情報
  • 2023年3月：第1版公開
    以下の2機能を提供していました。
    • (1) 指定コースに対するコースモジュールIDの取得
    • (2) 指定したコースモジュールIDに関する受講履歴の取得

お申し込み方法

■ STEP1：利用条件の確認と機能の選択
本機能は、機関ごとに代表者1名（コース管理者）がお申込みいただける機能です。
代表者には、機関ごとに発行されるトークンの管理を行っていただきます。
※同一機関において複数部局での利用希望がある場合：
機関内で1つの「代表部局（代表者1名）」を決定した上でお申し込みください。
代表者は、申請するAPIに対応するオプション機能（下記 括弧内）にお申込みいただいていることが利用条件となります。
未申請の場合は、別途利用申請をお願いいたします。

【対象の機能（複数選択可）】

■ STEP2：先行利用実施要領への同意
「先行利用実施要領」をご確認の上、ご同意ください。
■ STEP3：メールでの利用申し込み
所属機関の学認LMS連絡担当者から、学認LMSサポート担当へメールでご連絡ください。
他の機能の先行利用を同時にお申し込みいただく場合も、1つの機能につき1件のメールをお送りください。

【メール記載項目】

件名：【先行利用申込】受講履歴取得API

本文に記載する内容：

  • 機関名
  • 代表者氏名
  • 代表者所属
  • 招待メール送付先メールアドレス
  • 利用する機能（STEP 1の3種類から選択）
※申請に関する注意事項
コース管理者のアカウントは個人のePPNとひもづくため、個人の氏名、個人で使用するメールアドレスでの申請をお願いいたします。
（代表者氏名、招待メール送付先メールアドレスは、コース管理者と同一にしてください）
■ STEP4：mAP Core上のグループへの入会
申し込みからおよそ1週間の間に、学認LMSサポート担当より、グループへの入会完了のご連絡を差し上げます。
入会処理の詳細は、「mAP Core上のグループへの入会」の項目をご覧ください。
入会のご連絡は「noreply＠cg.gakunin.jp」というアドレスより配信されますので、あらかじめ上記ドメインからのメールを受信できるよう、設定のご確認をお願いいたします。
※＠を半角に変えて設定してください
■ STEP5：利用開始
グループへの入会が確認できましたら、API機能を利用するための「利用者マニュアル」を提供いたします。マニュアルには、履歴取得のためのcurlコマンド例が記載されています。
利用者マニュアルに沿って、学認LMS上で履歴取得API用のプラグインで、APIアクセスのためのトークンをご自分で発行してください。
このトークンを用いて、ご希望いただいたコースに関する学習履歴を WebAPIにより取得いただけます。

mAP Core上のグループへの入会

本機能をご利用いただくには、学認クラウドゲートウェイサービス上のグループ機能である「mAP Core（エムエーピーコア）」で管理されているグループへの入会が必要です。

【入会の手順】
■ STEP1：招待メールの受信
メールでの利用申し込みを行った後、学認クラウドゲートウェイサービスから 件名『[GakuNinCloudGS] 招待メール』というメールが届きます。
参考：お申し込み方法 > STEP3：メールでの利用申し込み
■ STEP2：URLをクリックして所属機関でログイン
メール最下部にある「<グループ入会URL>」をクリックします。
学認クラウドゲートウェイサービスのログイン画面が表示されたら、必ず「所属機関名（大学名など）」を選択してログインしてください。
Orthrosでログインした状態で招待メールのURLをクリックすると、自動的にOrthrosでグループに入会してしまいます。
Orthrosでグループに入会した場合、受講履歴取得API機能は利用できません。URLをクリックする前に、現在Orthrosでログインしていないかを必ずご確認ください。
もしログインしている場合は、一度ログアウトして所属機関IdPでログインし直してから、URLをクリックするようお願いいたします。
■ STEP3：入会手続きの完了
ログイン後、「GakuNinLMS_GradesAPI」グループの入会画面が表示されます。
条件に同意の上、チェックボックスにチェックを入れて「入会」をクリックしてください。
「GakuNinLMS_GradesAPIに入会しました。」と表示されれば完了です。
オプション機能の「利用中止」をご希望の場合、画面上の「退会」ボタンはクリックせず、
必ずユーザサポート担当までメールでご連絡くださいますようお願いいたします。

また、学認LMSまたは学認クラウドゲートウェイサービスへの最終ログインから2年間ご利用がないアカウントは、
オプション機能が利用できなくなりますのでご注意ください。

 

API機能一覧

本APIでは、以下の機能 (APIメソッド)を提供しております。
各APIメソッドで出力される情報は「APIリファレンス」を参照ください。

◇ 受講履歴取得API(第２版)-APIリファレンス.pdf(228.98 KB)

各APIメソッドのリクエスト形式は API利用者に提供される「利用者マニュアル」に掲載しています。

(1) コースモジュールidの取得
第１版の「指定コースに対するコースモジュールIDの取得」と同等の機能です。
(2) 受講レポートの取得
第１版の「指定したコースモジュールIDに関する受講履歴の取得」と同等の機能です。
※リクエスト時のパラメータを第２版では若干変更しておりますので、ご注意ください。
(3) インタラクションレポートの取得 新機能
SCORM コースモジュールの受講情報を取得できます。
情報セキュリティ講座のコース管理者が取得できていたものを APIで取得できます。
※ 2024年10月現在、情報セキュリティ講座の評点の一部に不具合がございます。
(4) 活動完了レポートの取得 新機能
コース内のモジュールに活動完了設定が行われている場合に、 活動完了レポートを取得できます。
(5) コース完了レポートの取得 新機能
コースにコース完了設定が行われている場合に、コース完了 レポートを取得できます。
(6) コースバッジ授与状況の取得 新機能
コース上で授与された各種バッジの状況を確認できます。
例えば、情報セキュリティ講座の活動完了バッジ (ウェルカム/満点/コンプリート)や、研究データ管理講座のコース完了バッジの授与状況を確認できます。
(7) コース情報の取得 新機能
各コースの基本設定や、コース完了情報の取得可否、コースで提供される バッジの一覧を確認できます。

参考資料

2024年度 第1回 学認SP研究会 ライトニングトーク 資料
学認LMS 受講履歴取得APIの改版
LC4RIのノートブック上でのAPI操作