API құжаттамасы
Smrt English Client API
Білім алушылар мен топтар туралы деректерді оқу орныңыздың жүйелеріне беретін, тек оқуға арналған API. Әр API кілті (API key) тек өз оқу орнының деректеріне қол жеткізеді.
Қалай жұмыс істейді
Сұрау қалай жұмыс істейді
Жүйеңіз білім алушы немесе топ деректерін өз API кілтімен (API key) сұрайды, ал API деректерді тек оқу режимінде қайтарады.
Smrt English API
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 authenticationGET /student/{id}- Get comprehensive data for a single studentGET /students- Get paginated list of students with summary statisticsGET /class/{id}- Get comprehensive data for a single classGET /classes- Get paginated list of classes with summary statistics
Base URL
Production: https://smrtenglish.com/smrtapi/v1/