lms-他システム連携/API

13-03-1.ログイン情報チェックAPI

更新日:

API名 ログイン情報チェックAPI
ID el_userlogin_check_api.php

2.詳細解説

受講者ログインIDとパスワードが正しいかをチェックするAPI。
当システムのIDを使ってログインチェックをする場合に利用します。
戻り値のログイン許可フラグでログインの可否を判断し、成功した場合、戻り値に含まれる受講者ID等の情報をセッションに設定してログイン後の動きを実装します。

$cstream->call_el_userlogin_check_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   ログインID login_id ログインをする際に必要なID。ASP設定により任意のID、メールアドレスのどちらかが使用される。
4   パスワード password ログイン認証に必要なパスワード。

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   パスワード password ログイン認証に必要なパスワード。
5   ログイン許可フラグ login_flg 1:ログイン許可 9:ログイン失敗
6   受講者情報 user_info ログイン許可フラグ=1の場合、ログインした受講者の情報を設定。
  6-1 受講者ID userid  
  6-2 受講者氏名 username  
  6-3 受講者氏名(カナ) usernamekana  
  6-4 性別 sex 区分値は変換して表示
  6-5 年齢 age  
  6-6 生年月日 birth  
  6-7 既婚/未婚 marry 区分値は変換して表示
  6-8 郵便番号 yubin  
  6-9 住所 address  
  6-10 電話番号 tdisp  
  6-11 メールアドレス mail  
  6-12 携帯メールアドレス mobileMail  
  6-13 職業 job 区分値は変換して表示
  6-14 法人名 incName  
  6-15 業種 bizType 区分値は変換して表示
  6-16 従業員数 enpNumber  
  6-17 部署名 departName  
  6-18 役職 position  
  6-19 講師権限付与フラグ lecturer_auth_add_flg  0:付与しない 1:付与する
  6-20 任意項目 other  
  6-21 連携項目1 api_val_user1  
  6-22 連携項目2 api_val_user2  
  6-23 連携項目3 api_val_user3  
  6-24 連携項目4 api_val_user4  
  6-25 連携項目5 api_val_user5  
  6-26 セクションID section_id  
  6-27 セクション名 section_name  
  6-28 所属期間From assign_date_from  
  6-29 所属期間To assign_date_to  

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

 

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.