Saltar al contenido principal

Estudiantes

Emisión de información de estudiantes​

Esta integración permitirá que la información de los estudiantes sea compartida entre ambos sistemas, asegurando que los datos estén siempre actualizados y sincronizados.

Generalidades/Requerimientos​

  • El proceso de emisión al sistema externo debe ser por medio de un endpoint que el sistema externo proporcione a Idukay.
  • La información emitida al sistema externo está en formato JSON.
  • Si el sistema externo no recibe la información o se presenta algún error, se notificará al sistema externo para que tome las acciones necesarias e intente nuevamente la emisión de la información.
  • Es importante seguir el estándar de emisión de información: en el momento de la creación, debe utilizarse un POST y para la actualización, un PUT.

Evento de crear estudiante​

warning

Es importante que la información devuelta por el sistema externo incluya el userId generado para el estudiante creado. Este userId es necesario para poder actualizar la información del estudiante.

Cada vez que se crea un estudiante en Idukay, se envía la información del estudiante creado al endpoint del sistema externo. El sistema externo debe estar preparado para recibir el evento de creación de estudiante y así obtener la información correspondiente.

Estructura datos estudiante▼
Ejemplo de emisión de información de estudiante
curl --method POST \
  --url https://example.com/api/integration/students \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Jhosep",
    "second_name": "Ryder",
    "surname": "Doe",
    "second_surname": "Smith",
    "email": "student-1@mail.com",
    "parents": ["60b31bd00000000000000000"],
    "metadata": {
      "role": "student",
      "school": "647582d00000000000000000",
      "user": "60b31bd00000000000000000",
    }
  }'
Respuesta sistema externo
{
  "status": "success",
  "data": {
    "userId": "60b31bd00000000000000000"
  }
}

Evento de actualizar estudiante​

warning

Es importante que el sistema externo garantice un update atómico de la información del estudiante. Es decir, Idukay enviará la información del estudiante con los campos que han sido actualizados, por lo que el sistema externo debe actualizar solo esos campos y no sobreescribir toda la información del estudiante.

Esto es crucial para evitar que la información del estudiante quede desactualizada.

Cada vez que se actualiza un estudiante en Idukay, se envía la información del estudiante actualizado al endpoint del sistema externo. El sistema externo debe estar preparado para recibir el evento de actualización de estudiante y así obtener la información correspondiente.

Estructura datos estudiante▼
Ejemplo de emisión de información de estudiante
curl --method PUT \
  --url https://example.com/api/integration/students/:userId \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Jhosep",
    "second_name": "Ryder",
    "surname": "Doe",
    "second_surname": "Smith",
    "email": "student-1@mail.com",
    "parents": ["60b31bd00000000000000000"],
    "metadata": {
      "role": "student",
      "school": "647582d00000000000000000",
      "user": "60b31bd00000000000000000",
    }
  }'
Respuesta sistema externo
{
  "status": "success",
  "data": {
    "userId": "60b31bd00000000000000000"
  }
}