Saltar al contenido

Documentación de la API

Client API de Smrt English

Una API de solo lectura que envía los registros de estudiantes y grupos a los sistemas de su institución. Cada API key solo tiene acceso a los datos de su propia institución.

Abrir el centro de pruebas

Cómo funciona

Cómo funciona una solicitud.

Su sistema solicita los datos de un estudiante o de un grupo con su propia API key, y la API devuelve los registros en modo de solo lectura.

Su sistemaSu sistema de información estudiantil o su herramienta de reportes.
Su API keySe envía con cada solicitud y está vinculada a su institución.
API de Smrt EnglishEndpoints de solo lectura para estudiantes y grupos.
Sus registrosCalificaciones, asistencia y listas de clase en formato JSON.
keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

  • X-API-Key (recommended)
  • X-Api-Key
  • HTTP_X_API_KEY (server variable)

Security Notes

  • Keep your API key confidential and do not share it outside your institution
  • Never expose API keys in client-side code or public repositories
  • Use HTTPS for all API requests (enforced in production)
  • Your API key only provides access to your institution's student data