概要
このドキュメントは、WebClass の WebAPI の利用手順について記載します。
WebClassで利用できるWebAPIの詳細ついては以下のドキュメントをご覧ください。
WebAPI の有効化
WebAPI を利用するには、事前に WebClass に ClientID と トークン取得用認証キー を設定する必要があります。この設定はサポートが行いますので、ClientID を指定してください。
- ClientID は、API を利用するシステムを識別するためのものです。
-
URL または英数字の文字列を使用します。
例:
https://some.existing.service/
サポートが認証キーを生成し、ClientID と一緒に登録します。登録後、認証キーを通知します。
トークンの取得
ClientID と トークン取得用認証キー を使用してアクセストークンを取得します。
Form形式の場合
curl -X POST https://your.webclass.site/webclass/api.php/auth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "client_id=YOUR-CLIENT-ID&key=YOUR-SECRET-KEY"JSON形式の場合 (WebClass v12 以降)
curl -X POST https://your.webclass.site/webclass/api.php/auth/token \
-H "Content-Type: application/json" \
-d '{"client_id":"YOUR-CLIENT-ID", "key":"YOUR-SECRET-KEY"}'レスポンス例
{
"result": "OK",
"token": "xxxxxxxxxx"
}API の利用
取得したトークンを Bearer ヘッダー に設定して API を呼び出します。
教材の成績データ取得API の例
:contents_id はデータを取り出す教材 ID に置き換えます。
curl -X GET https://your.webclass.site/webclass/api.php/rest/contents/:contents_id/scores \
-H "Authorization: Bearer xxxxxxxx"利用例
WebAPIの利用例として、ユーザ登録APIとコースユーザ登録APIの利用方法を紹介します。
ユーザ登録
ユーザ登録 API を利用して、新しいユーザを登録します。
- メソッド:
POST - Content-Type:
application/json
ユーザ登録 API エンドポイント
https://サーバホスト/webclass/api.php/rest/user送信データ例
{
"user_id": "id000001",
"fullname": "鈴木 先生",
"email": "suzukisensei@example.com",
"perm": "1",
"student_id": "2022000001",
"login_id": "extid000001"
}返却データ例
{
"result": "Registration successful. user_id <id000001> added."
}コースユーザ登録
コースユーザ登録 API を利用して、コースにユーザを登録します。
- メソッド:
POST - Content-Type:
application/json
コースユーザ登録 API エンドポイント
https://サーバホスト/webclass/api.php/rest/course/APITestCourse/member送信データ例
{
"user_id": "id000001",
"course_perm": "0"
}返却データ例
{
"result": "Registration successful. user_id <id000001> added."
}
