본문 바로가기

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/