本文へスキップ

APIドキュメント

Smrt English Client API

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

テストハブを開く

仕組み

リクエストの仕組み

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

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

Smrt English API

info Overview

The Smrt English Student Data API provides your institution with secure, read-only access to comprehensive student progress and engagement data. This REST API enables you to integrate student data into your own learning management systems, perform educational analytics, and track student progress programmatically.

Note: This API is currently in beta. If you encounter any issues or have questions, please submit them to Smrt support.

Key Features

  • Read-Only Access - Safe access to your student and class data without risk of modification
  • Institutional Security - Your API key only accesses data from your institution
  • Comprehensive Data - Access to assignments, assessments, quizzes, exams, and engagement metrics
  • Flexible Lookup - Find students by user ID or email address, classes by class ID
  • Bulk Data Retrieval - Get paginated lists of students and classes with filtering and search
  • Real-Time Data - All data reflects current student and class progress
  • RESTful Design - Standard HTTP methods and JSON responses make integration straightforward

Available Endpoints

  • GET /auth - Test API key authentication
  • GET /student/{id} - Get comprehensive data for a single student
  • GET /students - Get paginated list of students with summary statistics
  • GET /class/{id} - Get comprehensive data for a single class
  • GET /classes - Get paginated list of classes with summary statistics

Base URL

Production: https://smrtenglish.com/smrtapi/v1/