本文へスキップ

APIドキュメント

Smrt English Client API

生徒とクラスの記録を教育機関のシステムに返す、読み取り専用のAPIです。各APIキー（API key）でアクセスできるのは、その教育機関のデータに限られます。

テストハブを開く

仕組み

リクエストの仕組み

教育機関のシステムが自身のAPIキーを使って生徒またはクラスの情報を要求し、APIは記録を読み取り専用で返します。

教育機関のシステム生徒情報を管理するシステムやレポートツールです。
APIキーリクエストごとに送信され、学校に紐づけられています。
Smrt English API生徒とクラスのための読み取り専用のエンドポイントです。
学習記録成績、出欠、クラス名簿をJSONで受け取ります。
keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

  • X-API-Key (recommended)
  • X-Api-Key
  • HTTP_X_API_KEY (server variable)

Security Notes

  • Keep your API key confidential and do not share it outside your institution
  • Never expose API keys in client-side code or public repositories
  • Use HTTPS for all API requests (enforced in production)
  • Your API key only provides access to your institution's student data