Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/miagv/PlataformaEduca/llms.txt

Use this file to discover all available pages before exploring further.

Teachers in PlataformaEduca — referred to as Docente — are assigned to specific courses and classrooms by the institution’s coordinator. Once assigned, your role is to define the evaluation structure for each course (tests, quizzes, exams) and record each student’s grade against those evaluations. The platform resolves your identity from the JWT token on every request, so you only ever see data that belongs to your assignments.

​
Authentication

Obtain a JWT token by posting your credentials to the shared auth endpoint. 
curl -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "teacher@school.edu", "password": "yourpassword"}'
Pass this token as a Bearer header on every subsequent request.

​
Viewing your assigned courses

The platform resolves your identity from the email embedded in your JWT and returns only the assignments that belong to you. 
curl -X GET http://localhost:8080/api/docente/mis-cursos \
  -H "Authorization: Bearer <token>"

[
  {
    "id": 5,
    "docente": { "id": 3, "nombre": "Ana Torres" },
    "curso":   { "id": 1, "nombre": "Matemáticas" },
    "aula":    { "id": 2, "nombre": "Aula 205" },
    "periodo": { "id": 1, "nombre": "2024-I" }
  }
]
The top-level id in each record is the asignacion ID (asignacionDocente.id). You will need this value when creating evaluations and retrieving statistics.

​
Creating an evaluation

An Evaluacion represents a single graded activity — a test, quiz, homework assignment, or exam. Each evaluation carries a porcentaje (percentage weight) that determines how much it contributes to a student’s final grade. 
curl -X POST http://localhost:8080/api/docente/evaluaciones \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "titulo":            "Examen Parcial",
    "porcentaje":        30.0,
    "fecha":             "2024-06-15",
    "curso":             { "id": 1 },
    "asignacionDocente": { "id": 5 }
  }'
FieldTypeDescription
titulostringDisplay name for the evaluation
porcentajenumberWeight toward the final grade (e.g., 30.0 means 30%)
fechastringEvaluation date in YYYY-MM-DD format
cursoobjectThe course this evaluation belongs to
asignacionDocenteobjectYour assignment record — obtained from /api/docente/mis-cursos
Make sure the sum of all porcentaje values across evaluations for a given assignment does not exceed 100. PlataformaEduca does not enforce this automatically.

​
Recording a student grade

Once an evaluation exists, record each student’s score with a POST to the notes endpoint. 
curl -X POST http://localhost:8080/api/docente/notas \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "nota":        18.5,
    "observacion": "Excelente desempeño",
    "evaluacion":  { "id": 1 },
    "estudiante":  { "id": 7 }
  }'
FieldTypeDescription
notanumberNumeric score — the platform uses a 0–20 scale by convention
observacionstringOptional teacher comment visible to the student
evaluacionobjectThe evaluation being graded
estudianteobjectThe student receiving the grade
You need the student’s id. Students are registered in the system with a unique codigo and are visible through the admin user management endpoints if you need to look up IDs.

​
Viewing assignment statistics

Retrieve a summary of evaluation activity for a specific assignment. 
curl -X GET http://localhost:8080/api/docente/estadisticas/5 \
  -H "Authorization: Bearer <token>"

{
  "totalEvaluaciones": 3
}
Replace 5 with your asignacionDocente ID. This endpoint currently returns the total number of evaluations created under that assignment.

​
Common workflow

1

Log in and obtain a JWT token

POST to /api/auth/login with your teacher credentials. Save the returned token.
2

View your assigned courses

GET /api/docente/mis-cursos to see all courses assigned to you. Note the top-level id of each record — this is the asignacionDocente ID you will reference throughout.
3

Create an evaluation

POST to /api/docente/evaluaciones with a title, percentage weight, date, course ID, and your asignacion ID. Repeat for each graded activity in the course (midterm, final, assignments, etc.).
4

Record student grades

POST to /api/docente/notas for each student and each evaluation. Provide the student’s ID, the evaluation’s ID, the numeric score, and an optional observation.
5

Review assignment statistics

GET /api/docente/estadisticas/{asignacionId} to confirm how many evaluations have been created for the assignment and verify your grading progress.

Build docs developers (and LLMs) love

Get started for freeTalk to us