Langsung ke konten

Dokumentasi API

Smrt English Client API

API hanya-baca (read-only) yang mengirimkan data siswa dan kelas ke sistem institusi Anda. Setiap kunci API (API key) hanya dapat mengakses data institusinya sendiri.

Buka pusat pengujian

Cara kerjanya

Cara kerja sebuah permintaan.

Sistem Anda meminta data seorang siswa atau sebuah kelas dengan kunci API miliknya sendiri, dan API mengembalikan data tersebut dalam mode hanya-baca.

Sistem AndaSistem informasi siswa atau alat pelaporan Anda.
Kunci API AndaDikirim bersama setiap permintaan dan terhubung ke sekolah Anda.
Smrt English APIEndpoint hanya-baca untuk siswa dan kelas.
Data AndaNilai, kehadiran, dan daftar siswa kelas dalam format 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/