当システムで利用可能なAPIを以下に記載します。詳細を確認したい方は「詳細」リンクをクリックしてください。
APIバージョン |
Ver3 (E-learningASP-V5対応) |
No |
API名称 |
API-ID |
解説 |
|
1 |
ログイン情報チェックAPI |
el_userlogin_check_api |
受講者ログインIDとパスワードが正しいかをチェックするAPI |
詳細 |
2 |
講座一覧取得API |
el_course_list_get_api |
検索条件を指定して該当する講座の一覧を取得するAPI |
詳細 |
3 |
講座グループ一覧取得API |
el_courseGroup_list_get_api |
検索条件を指定して該当する講座グループの一覧を取得するAPI |
詳細 |
4 |
講座分類一覧取得API |
el_course_category_list_get_api |
検索条件を指定して該当する講座分類の一覧を取得するAPI |
詳細 |
5 |
受講状況取得API |
el_user_record_get_api |
受講履歴(進捗率/動画視聴時間等)を取得するAPI |
詳細 |
6 |
アクションログ情報取得API |
el_actionlog_get_api |
アクションログ(詳細はこちら)を取得するAPI |
詳細 |
7 |
講座グループ個別取得API |
el_courseGroup_kobetsu_get_api |
講座グループの詳細情報(紐づく講座ID等)を取得するAPI |
詳細 |
8 |
講座個別取得API |
el_course_kobetsu_get_api |
講座の詳細情報を取得するAPI |
詳細 |
9 |
講義情報取得API |
el_course_lecture_get_api |
講座に紐づく講義の情報を取得するAPI |
詳細 |
10 |
動画視聴履歴取得API |
vd_movie_log_get_api |
動画の視聴情報を取得するAPI |
詳細 |
11 |
受講者情報取得API |
el_userInfo_get_api |
受講者情報を取得するAPI |
詳細 |
12 |
継続決済IF情報取得API |
el_montlypayIFInfo_get_api |
継続決済IF情報を取得するAPI |
詳細 |
13 |
受講者情報編集API |
el_userInfo_upd_api |
受講者IDの登録/編集を行うAPI |
詳細 |
14 |
受講者権限編集API |
el_userAuth_upd_api |
受講者に講座(講座グループ/カリキュラム)の受講権限を付与するAPI |
詳細 |
15 |
採番API |
el_numbering_api |
継続決済IFを使った登録をする際に、会員IDをGMO社に渡す必要があり、事前に受講者IDを採番する必要がある。その場合に利用するAPI |
詳細 |
16 |
退会API |
el_quit_api |
受講者を退会させるAPI。受講者情報編集APIで受講者ステータスを9(削除)に更新した場合と同様だが、退会APIを実行するとLMSの退会通知メールが対象者に送信されるところが異なる |
詳細 |
17 |
商品情報取得API |
el_productInfo_get_api |
商品マスタの情報を取得するAPI |
詳細 |
18 |
クーポンコードチェックAPI |
el_couponCode_check_api |
商品マスタでクーポン機能を使う場合、クーポンコードが正しいかを判断する必要がある。その際に利用されるAPI。 |
詳細 |
19 |
販売情報登録API |
el_orderInfo_upd_api |
申込画面を作成してGMO社と連携する場合必ず利用するAPI。詳しくは詳細を参照してください。 |
詳細 |
20 |
販売情報個別取得API |
el_orderInfo_get_api |
申込画面を作成してGMO社と連携する場合利用するAPI。詳しくは詳細を参照してください。 |
詳細 |
21 |
販売履歴登録API |
el_orderRireki_upd_api |
オーダー履歴情報を登録するAPI。 |
詳細 |
22 |
販売履歴個別取得API |
el_orderRireki_get_api |
オーダー履歴情報を取得するAPI。 |
詳細 |
23 |
領収書情報取得API |
el_ReceiptInfo_get_api |
領収書情報(領収書のダウンロードURLを含む)を取得するAPI。 |
詳細 |
24 |
販売セクション請求書情報取得API |
el_SectionBillInfo_get_api |
販売セクションから発行された請求書の情報(請求書のダウンロードURLを含む)を取得するAPI。 |
詳細 |
25 |
メール文面取得API |
el_MailContents_get_api |
メール文面を取得するAPI。 |
詳細 |
26 |
継続決済IF情報編集API |
el_monthlypayIFInfo_upd_api |
継続決済IFに受講者を所属させたり、退会させたりするAPI |
詳細 |
27 |
お知らせ情報取得API |
el_info_get_api |
お知らせ内容を取得するAPI。 |
詳細 |
28 |
商品情報一覧取得API |
el_productList_get_api |
商品情報を一覧取得するAPI。 |
詳細 |
29 |
Q&A一覧取得API |
el_qaList_get_api |
Q&A情報を一覧取得するAPI。 |
詳細 |
30 |
Q&A個別取得API |
el_qaInfo_get_api |
Q&A情報を個別取得するAPI。 |
詳細 |
31 |
Q&A情報登録API |
el_qaInfo_upd_api |
Q&A情報を登録するAPI。 |
詳細 |