Перейти до вмісту

Документація API

Клієнтський API Smrt English

API лише для читання, який передає дані учнів і груп у системи вашого закладу. Кожен API-ключ (API key) дає доступ лише до даних свого закладу.

Відкрити центр тестування

Як це працює

Як виконується запит

Ваша система запитує дані учня або групи за власним API-ключем, а API повертає записи лише для читання.

Ваша системаВаша система обліку учнів або інструмент звітності.
Ваш API-ключНадсилається з кожним запитом і прив’язаний до вашого закладу.
API Smrt EnglishЕндпоінти (кінцеві точки) для учнів і груп, лише для читання.
Ваші даніОцінки, відвідуваність і списки груп у форматі 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/