13-02.API連携(事前準備) - E-learning ASP V6 利用マニュアル

13-02.API連携(事前準備)

更新日：2020年5月7日

13-02-1.API連携とは

E-learningASPでは、他のWEBシステムと連携するためのAPIを完備しています。
学習結果や講座へのリンクをポータルサイトに表示することも可能です。
APIからはE-learningASPに登録されているあらゆる情報を他システムから取得できるほか、会員登録用のAPIなども用意しています。

豊富なAPIにより、会員登録～受講までをすべてオリジナルサイトとして構築することも可能です。

APIの利用には当社製品の契約時にAPI利用が可能なプランでのお申込みと、API利用の追加料金のご契約が必要になります。
料金プランについての詳細は当社HP（こちら）をご覧ください。

13-02-2.アクセスキーの取得

管理サイトログイン＞サイトTOP（E-learning）＞メニュー（基本設定）＞ASP基本情報設定

APIを利用するにはアクセスキーと呼ばれるファイルが必要になります。ASP基本情報設定の「機能関連」のボックスから「API」が「利用する」になっていることを確認してください。（チェックがない場合、API利用できる契約プランになっていないことが考えられます。その際は別途営業担当までお問合せください。）
右側の「APIアクセスキー」の内容をメモしてください。このアクセスキーは後から利用します。

13-02-3.呼出用ファイル(c_stream_api.php)の取得・編集

APIを利用するには、APIを呼び出す元のサーバに呼出用ファイルを配置し、そのファイルをAPIの呼び出し元プログラムからrequireする必要があります。
呼出用ファイルをこちらからダウンロードして、ZIPファイルを解凍して中身を開いてください

// c-stream API
define("CS_API_URL", "https://www.c-streaming.net/v5/c-stream-api/");
define("CS_KAISHA_ID", "");//登録の会社IDを入れる
define("CS_ACCESS_KEY", "");//API用のaccess_key

// c_stream_apiクラス生成
class c_stream_api {

// c-stream API

define("CS_API_URL", "https://www.c-streaming.net/v5/c-stream-api/");

define("CS_KAISHA_ID", "");//登録の会社IDを入れる

define("CS_ACCESS_KEY", "");//API用のaccess_key

// c_stream_apiクラス生成

class c_stream_api {

3行目のCS_KAISHA_IDに会社IDを、4行目のCS_ACCESS_KEYにさきほど取得したアクセスキーを入力して保存してください。
会社IDが00000、アクセスキーが12345678だった場合は以下のようになります。

// c-stream API
define("CS_API_URL", "https://www.c-streaming.net/v5/c-stream-api/");
define("CS_KAISHA_ID", "00000");//登録の会社IDを入れる
define("CS_ACCESS_KEY", "12345678");//API用のaccess_key

// c_stream_apiクラス生成
class c_stream_api {

// c-stream API

define("CS_API_URL", "https://www.c-streaming.net/v5/c-stream-api/");

define("CS_KAISHA_ID", "00000");//登録の会社IDを入れる

define("CS_ACCESS_KEY", "12345678");//API用のaccess_key

// c_stream_apiクラス生成

class c_stream_api {

13-02-4.呼出用ファイル(c_stream_api.php)の配置、サーバ設定

APIを利用するために、先ほど作成した呼出用ファイルをサーバのWebディレクトリに配置してください。
なお、APIを利用するにはPHP5以上、cURLインストール済みのサーバ環境が必要です。
（cURLのインストール状況は、「php -i | grep cURL」というコマンドで確認できます）

13-02-5.APIの呼び出し

APIの呼び出しプログラムの実装例をご覧ください

require 'c-stream_api_v3.php'; //呼出用ファイルへのパスを通す

// パラメータ準備
$params = array(
    'kaisha_id'     => '00000', // 会社ID
    'access_key' => '12345678'
);
try {
    $cstream = new c_stream_api($params); //APIクラスを生成
    $login_id = 'XXXXX';
    $passwd = 'XXXXX';
    $output = $cstream->call_el_userlogin_check_api('login_id' => $login_id , 'password' => $passwd); //APIの呼び出し

    if($output['exec_flg'] == 1){
	    //正常終了時の処理
	    echo $output['login_flg'];
    }else{
	    //エラー時の処理
	    echo $output['error_type']." : ".$output['error_msg'];
    }
} catch (Exception $e) {
    print_r($e);
}

require 'c-stream_api_v3.php'; //呼出用ファイルへのパスを通す

// パラメータ準備

$params = array(

'kaisha_id' => '00000', // 会社ID

'access_key' => '12345678'

);

try {

$cstream = new c_stream_api($params); //APIクラスを生成

$login_id = 'XXXXX';

$passwd = 'XXXXX';

$output = $cstream->call_el_userlogin_check_api('login_id' => $login_id , 'password' => $passwd); //APIの呼び出し

if($output['exec_flg'] == 1){

//正常終了時の処理

echo $output['login_flg'];

}else{

//エラー時の処理

echo $output['error_type']." : ".$output['error_msg'];

}

} catch (Exception $e) {

print_r($e);

}

１行目：まず呼出用ファイルへのパスを通します。
4-9行目：基本パラメータを入力し、c_stream_apiクラスを生成しています。
12行目：el_userlogin_check_apiを呼び出しています。呼び出すことができるAPIの種類については、APIリファレンスを参照してください
14-20行目：実行結果をもとに正常処理とエラー処理を行っています。必ずエラー処理を実装してください。