APIドキュメント

Smrt English Client API

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

テストハブを開く

仕組み

リクエストの仕組み

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

教育機関のシステム生徒情報を管理するシステムやレポートツールです。

APIキーリクエストごとに送信され、学校に紐づけられています。

Smrt English API生徒とクラスのための読み取り専用のエンドポイントです。

学習記録成績、出欠、クラス名簿をJSONで受け取ります。

keyboard_arrow_up

Smrt English API

verified_user Authentication Test Endpoint

Endpoint Details

Endpoint: GET /smrtapi/v1/auth

Purpose: Verify that your API key is valid and active

Headers Required

X-API-Key: your_institution_api_key

Example Request

curl -H "X-API-Key: your_institution_api_key" \
  https://smrtenglish.com/smrtapi/v1/auth

Use Cases

Verify API key before implementing full integration
Test connectivity to the API
Confirm school information and permissions
Health check for API availability

Response Format

Success Response (200 OK):

{
  "success": true,
  "data": {
    "authenticated": true,
    "school": {
      "id": 1,
      "name": "Your Institution Name",
      "key": "your_institution"
    },
    "api_key_name": "Your Institution Production API Key",
    "timestamp": "2025-09-29 22:20:32"
  },
  "message": "API key is valid and active"
}

Error Response (401 Unauthorized):

{
  "error": true,
  "message": "Authentication required",
  "status_code": 401,
  "error_code": "AUTH_REQUIRED"
}

Response Fields

Field	Type	Description
`authenticated`	boolean	Always true for successful auth
`school.id`	integer	Your institution's unique ID
`school.name`	string	Your institution's name
`school.key`	string	Your institution's unique key
`api_key_name`	string	Friendly name for the API key
`timestamp`	string	Server timestamp