Ⅴ. API編

APIトークン・共通仕様・ライブラリ

 

v1.0 トークンの取得、ユーザー登録・編集・削除APIの作成

v1.1 OpenIDの項目を追加

v2.0 上長の登録・一括削除APIの作成

v3.0 進捗取得APIの作成

 

1.APIトークンの取得

APIを使用するにはトークンの取得が必要になります。トークンは管理画面から取得してください。

管理画面にログイン後に下記URLにアクセスしてください。

https://tlp.edulio.com/admin/users/token

トークンの発行および再発行ができます。

再発行した場合は以前のトークンが使用できなくなりますので注意してください。

 

2.APIトークンの使用

取得したトークンはAuthorizationヘッダにセットしてAPIをリクエストしてください。

 

3.レスポンスデータ

レスポンスデータはJSON形式です。

 

4.エラー時のレスポンスパラメータ

パラメータ 項目名 備考 error エラー内容 code HTTPステータスコード

 

5.ライブラリ(PHP)

ライブラリを御利用になる場合には、下記URLからzipファイルをダウンロードしてください。

 https://drive.google.com/a/abcd-p.com/file/d/12BlBlrLLbZMOSGbSDtKZ9Uu5parQhthC/view?usp=sharing

 

 

 

01.ユーザーの登録

概要

※開発言語はPHPを前提としています。

【リクエストURL】

【POST】https://api.edulio.com/members/add

1)cURLを用いたサンプルコード

$post = array(

  'unique_id' => 'apitest',

  'name' => 'APIユーザー',

  'email' => 'test@edulio.com',

  'password' => 'test1234',

  'entry_date' => '2017-05-01',

  'time_limit' => '2018-03-31',

  'memo' => 'フリーメモ',

  'group' => array(

    'マスタ1' => 'グループ1',

    'マスタ2' => 'グループ2',

  ),

  'birthday' => '1980-07-01',

  'sex' => 1,

  'zip' => '100-0005',

  'pref' => '東京都',

  'city' => '千代田区',

  'street' => '丸の内1-6-2',

  'tel' => '050-3204-4407',

  'company' => '株式会社ABCD Partners',

  'post' => 'CEO',

  'learning_flg' => 1,

);

$accessToken = '取得したトークン';

$url = 'https://api.edulio.com/members/add';

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

curl_setopt($ch, CURLOPT_POST, TRUE);

curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード

$post = array(

  'unique_id' => 'apitest',

  'name' => 'APIユーザー',

  'email' => 'test@edulio.com',

  'entry_date' => '2017-05-01',

  'time_limit' => '2018-03-31',

  'memo' => 'フリーメモ',

  'group' => array(

    'マスタ1' => 'グループ1',

    'マスタ2' => 'グループ2',

  ),

  'birthday' => '1980-07-01',

  'sex' => 1,

  'zip' => '100-0005',

  'pref' => '東京都',

  'city' => '千代田区',

  'street' => '丸の内1-6-2',

  'tel' => '050-3204-4407',

  'company' => '株式会社ABCD Partners',

  'post' => 'CEO',

  'learning_flg' => 1,

);

$accessToken = '取得したトークン';

require_once 'init.php';

$api = new EdulioMemberApi($accessToken);

$api->memberAdd($post);

 

02.ユーザーの編集

概要

※開発言語はPHPを前提としています。

【リクエストURL】

【POST】https://api.edulio.com/members/edit/{unique_id}

 

1)cURLを用いたユーザーサンプルコード

$post = array(

  'unique_id' => 'apitest',

  'name' => 'APIユーザー',

  'email' => 'test@edulio.com',

  'memo' => 'フリーメモ',

  'group' => array(

    'マスタ1' => 'グループ1',

    'マスタ2' => 'グループ2',

  ),

  'learning_flg' => 1,

);

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/members/edit/'.$unique_id;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

curl_setopt($ch, CURLOPT_POST, TRUE);

curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード

$post = array(

  'unique_id' => 'apitest',

  'name' => 'APIユーザー',

  'email' => 'test@edulio.com',

  'memo' => 'フリーメモ',

  'group' => array(

    'マスタ1' => 'グループ1',

    'マスタ2' => 'グループ2',

  ),

  'lerning_flg' => 1,

);

$accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioMemberApi($accessToken);

$api->memberEdit($unique_id, $post);

 

03.ユーザーのゴミ箱への移動

※開発言語はPHPを前提としています。

【リクエストURL】

【DELETE】 https://api.edulio.com/members/trash/{unique_id}

 

1)cURLを用いたサンプルコード

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/members/trash/'.$unique_id;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード

$accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioMemberApi($accessToken);

$api->memberTrash($unique_id);

 

04.ユーザーをゴミ箱から戻す

 

※開発言語はPHPを前提としています。

【リクエストURL】 【GET】 https://api.edulio.com/members/restore/{unique_id}

 

1)cURLを用いたサンプルコード

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/members/restore/'.$unique_id;

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード  

$accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioMemberApi($accessToken);

$api->memberRestore($unique_id);

 

05.ユーザーの削除

 

※開発言語はPHPを前提としています。

【リクエストURL】 【DELETE】 https://api.edulio.com/members/delete/{unique_id}

 

1)cURLを用いたサンプルコード  

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/members/delete/'.$unique_id;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード  

$accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioMemberApi($accessToken);

$api->memberDelete($unique_id);

 

06.上長の設定

 

概要

※開発言語はPHPを前提としています。

※管理画面の上長設定が「ユーザー単位」になっていることが前提です。

 

 

【リクエストURL】 【POST】 https://api.edulio.com/tutors/setting/{unique_id}/{type}

※{type}は登録か削除かを指定するパラメータ。「add」なら登録、「delete」なら削除

 

1)cURLを用いたサンプルコード

$post = array('testuser1', 'testuser2', 'testuser3');

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$type = 'add';

$url = 'https://api.edulio.com/tutors/setting/'.$unique_id.'/'.$type;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

curl_setopt($ch, CURLOPT_POST, TRUE);

curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード

 $post = array('testuser1', 'testuser2', 'testuser3');

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$type = 'add';

require_once 'init.php';

$api = new EdulioTutorApi($accessToken);

$api->tutorSetting($unique_id, $type, $post);

 

07.上長の一括削除

 

※開発言語はPHPを前提としています。

※管理画面の上長設定が「ユーザー単位」になっていることが前提です。

 

【リクエストURL】

【DELETE】 https://api.edulio.com/tutors/delete/{unique_id}

 

1)cURLを用いたサンプルコード  

$accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/tutors/delete/'.$unique_id;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード  

 $accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioTutorApi($accessToken);

$api->tutorDelete($unique_id);

 

08.進捗データの取得

 

※開発言語はPHPを前提としています。

【リクエストURL】 【GET】 https://api.edulio.com/progresses/get/{unique_id}

 1)cURLを用いたサンプルコード  

 $accessToken = '取得したトークン';

$unique_id = 'apitest';

$url = 'https://api.edulio.com/progresses/get/'.$unique_id;

 

$ch = curl_init();

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: '.$accessToken));

$result = curl_exec($ch);

curl_close($ch);

 

2)ライブラリを用いたサンプルコード  

$accessToken = '取得したトークン';

$unique_id = 'apitest';

require_once 'init.php';

$api = new EdulioProgressApi($accessToken);

$api->progressGet($unique_id);

株式会社ABCD Partners
〒100-0004 東京都千代田区大手町1-7-2 東京サンケイビル27階
お問合わせ:edulio@abcd-p.com
Copyright © ABCD-Partners. All Rights Reserved.