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

error Error Handling

Error Response Format

All errors follow a consistent JSON structure:

{
  "error": true,
  "message": "Human-readable error description",
  "status_code": 401,
  "error_code": "AUTH_FAILED"
}

HTTP Status Codes

Status Code Meaning When It Occurs
200 OK Successful request
401 Unauthorized Invalid or missing API key
404 Not Found Student or class not found or not in your school
405 Method Not Allowed Using wrong HTTP method (only GET supported)
422 Validation Error Invalid parameter format (e.g., malformed email)
429 Too Many Requests Rate limit exceeded (if implemented)
500 Internal Server Error Server error (contact support)

Common Error Responses

Invalid API Key

{
  "error": true,
  "message": "Invalid or missing API key",
  "status_code": 401,
  "error_code": "AUTH_FAILED"
}

Causes:

  • API key not included in header
  • API key is incorrect
  • API key has been deactivated by Smrt English
  • Wrong header name used

Solution: Verify your API key and header format. If issues persist, contact your Smrt English representative.

Student Not Found

{
  "error": true,
  "message": "The requested student was not found or you don't have permission to access it",
  "status_code": 404,
  "error_code": "NOT_FOUND"
}

Causes:

  • Student ID doesn't exist in the Smrt English system
  • Student belongs to a different institution
  • Student account has been deleted
  • Email address doesn't match any student enrolled at your institution

Solution: Verify the student ID/email and confirm the student is enrolled at your institution through Smrt English.

Method Not Allowed

{
  "error": true,
  "message": "Method not allowed",
  "status_code": 405,
  "error_code": "METHOD_NOT_ALLOWED"
}

Causes:

  • Using POST, PUT, DELETE, or PATCH instead of GET

Solution: This is a read-only API. Use GET method only.