Administración escolar
Conectar sus sistemas con la API de Smrt English
Consulte los registros de estudiantes y grupos de su escuela desde sus propios sistemas con una API key de Smrt English.
La API de Smrt English permite que los sistemas de su escuela, como un sistema de información estudiantil o un panel de reportes, consulten los registros de sus estudiantes y grupos. Es de solo lectura: no puede agregar, cambiar ni eliminar nada en Smrt English.
Obtener una API key
Comuníquese con Smrt English para solicitar una API key para su escuela. Smrt English emite y administra las claves. Una clave solo devuelve los estudiantes y grupos de su propia escuela.
Una vez que su escuela tenga una clave, abra el Dashboard, haga clic en Home y después en Settings (Configuración). El cuadro Client API muestra cuántas claves están activas y cuántas solicitudes hicieron en los últimos 30 días.
Entregue la clave a la persona que desarrolla su integración. Esa persona la envía en el encabezado X-API-Key de cada solicitud.
Qué puede consultar
- Estudiantes: una lista de sus estudiantes con filtros y búsqueda, o un estudiante por ID de usuario o correo electrónico, con sus grupos, tareas completadas, evaluaciones y tiempo dedicado al aprendizaje.
- Grupos: una lista de sus grupos, o un grupo con su docente y su lista de estudiantes.
- Auth: una prueba que comprueba que su clave funciona.
La referencia completa, con ejemplos en PHP, Python y JavaScript, está en la documentación de la API. Su desarrollador puede probar cada endpoint en el navegador desde la página de pruebas enlazada ahí.
Trate la clave como una contraseña. Guárdela en su servidor, nunca en una página web ni en una aplicación. Si cree que quedó expuesta, comuníquese con Smrt English de inmediato.
