Smrt English APIで学校のシステムと連携する

Smrt English APIを使うと、学生情報システムやレポート用のダッシュボードなど、学校のシステムから生徒とクラスの記録を読み取れます。APIは読み取り専用で、Smrt Englishのデータを追加、変更、削除することはできません。

APIキーを取得する

学校用のAPIキー（API key）を申請するには、Smrt Englishにお問い合わせください。APIキーはSmrt Englishが発行・管理します。1つのAPIキーで取得できるのは、自校の生徒とクラスだけです。

1. APIキーが発行されたら、Dashboardを開いてHomeをクリックし、Settingsをクリックします。Client API欄に、有効なAPIキーの数と、過去30日間のリクエスト数が表示されます。

   

2. 連携を開発する担当者にAPIキーを渡します。担当者は、すべてのリクエストのX-API-KeyヘッダーでAPIキーを送信します。

読み取れる内容

• Students（生徒）：絞り込みと検索ができる生徒の一覧、またはユーザーIDかメールアドレスで指定した生徒1人の情報です。所属クラス、完了した課題、評価、学習時間を含みます。
• Classes（クラス）：クラスの一覧、または担当教師と生徒名簿を含むクラス1つの情報です。
• Auth（認証）：APIキーが機能するかを確認するテストです。

PHP、Python、JavaScriptの例を含む詳細なリファレンスは、APIドキュメントにあります。開発担当者は、そこからリンクしているテスト用のページで、すべてのエンドポイントをブラウザー上で試せます。