Vai al contenuto

Documentazione API

Smrt English Client API

Un’API in sola lettura che trasmette i dati di studenti e classi ai sistemi del vostro istituto. Ogni chiave API (API key) accede solo ai dati del proprio istituto.

Apri l’area di test

Come funziona

Come funziona una richiesta.

Il vostro sistema richiede i dati di uno studente o di una classe con la propria chiave API, e l’API li restituisce in sola lettura.

Il vostro sistemaIl gestionale degli studenti o lo strumento di reportistica.
La vostra chiave APIInviata con ogni richiesta e associata alla vostra scuola.
API di Smrt EnglishEndpoint in sola lettura per studenti e classi.
I vostri datiVoti, presenze ed elenchi delle classi in formato 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/