Amministrazione della scuola
Collegare i vostri sistemi con l’API Smrt English
Leggete dai vostri sistemi le schede degli studenti e delle classi della scuola con una chiave API fornita da Smrt English.
L’API Smrt English permette ai sistemi della vostra scuola, come un gestionale degli studenti o un pannello di reportistica, di leggere le schede degli studenti e delle classi. È di sola lettura: non può aggiungere, modificare o eliminare nulla in Smrt English.
Ottenere una chiave API
Contattate Smrt English per richiedere una chiave API (API key) per la vostra scuola. È Smrt English a rilasciare e gestire le chiavi. Una chiave restituisce sempre e solo gli studenti e le classi della vostra scuola.
Quando la scuola dispone di una chiave, aprite il Dashboard, fate clic su Home, poi su Settings. Il riquadro Client API mostra quante chiavi sono attive e quante richieste hanno effettuato negli ultimi 30 giorni.
Consegnate la chiave alla persona che sviluppa l’integrazione, che la invierà nell’intestazione X-API-Key di ogni richiesta.
Che cosa potete leggere
- Studenti: l’elenco dei vostri studenti con filtri e ricerca, oppure un singolo studente per ID utente o indirizzo email, con le sue classi, i compiti completati, le verifiche e il tempo dedicato allo studio.
- Classi: l’elenco delle vostre classi, oppure una singola classe con il docente e l’elenco degli studenti.
- Auth: un test che verifica che la chiave funzioni.
Il riferimento completo, con esempi in PHP, Python e JavaScript, si trova nella documentazione dell’API. Lo sviluppatore può provare ogni endpoint nel browser dalla pagina di test collegata lì.
Trattate la chiave come una password. Conservatela sul vostro server, mai in una pagina web o in un’app. Se pensate che sia stata esposta, contattate subito Smrt English.
