API Integración Alborada

Generalidades:
Se ha generado una API HTTP JSON que es un método muy eficiente de realizar integraciones.

El API se encuentra pública en la dirección principal del aplicativo de la Institución Educativa:

Producción:  https://alborada.academi-cloud.net

Actualizar valores adeudados por código de estudiante:

Este método permite actualizar el monto total adeudado y un detalle de los valores pendientes por parte del estudiante mediante tomando como parámetro el código de estudiante.

RUTA COMPLETA:
https://alborada.academi-cloud.net/ext_ws/integracion_alborada/actualizar_deuda_por_codigo
EndPoint:
/ext_ws/integracion_alborada/actualizar_deuda_por_codigo
Method: POST
Params:
  • {api_key}: clave de autorización
  • {codigo}: código del estudiante
  • {valor_adeudado}: valor total adeudado
  • {valores_pendientes}: arreglo con el detalle de los valores pendientes de pago
Request Ejemplo:
{
 "api_key":  "############",
 "codigo":  "0885-E",
 "valor_adeudado": 120.65,
 "valores_pendientes":  [
  {
    "numero_factura" :  "001-001-0003875".
    "fecha" :  "01-02-2018",
    "monto_total" :  "120.65",
    "detalles" : [
      { "concepto" : "Pensión Enero", "valor" : "100.15" },
      { "concepto" : "Pensión Febrero", "valor" : "20.50" }
     ]
   }
 ]
}
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • mensaje: mensaje de la acción realizada
Ejem. Resultado: {
“resultado”: true,
“mensaje”: “Registro Actualizado Correctamente”
}

Actualizar valores adeudados por identificación del estudiante:

Este método permite actualizar el monto total adeudado y un detalle de los valores pendientes por parte del estudiante mediante tomando como parámetro el número de cédula o pasaporte del estudiante.

RUTA COMPLETA:
https://alborada.academi-cloud.net/ext_ws/integracion_alborada/actualizar_deuda_por_identificacion
EndPoint:
/ext_ws/integracion_alborada/actualizar_deuda_por_identificacion
Method: POST
Params:
  • {api_key}: clave de autorización
  • {identificacion}: número de identificación del estudiante
  • {valor_adeudado}: valor total adeudado
  • {valores_pendientes}: arreglo con el detalle de los valores pendientes de pago
Request Ejemplo:
{
 "api_key":  "############",
 "codigo":  "0885-E",
 "identificacion": "0105610335",
 "valores_pendientes":  [
  {
    "numero_factura" :  "001-001-0003875".
    "fecha" :  "01-02-2018",
    "monto_total" :  "120.65",
    "detalles" : [
      { "concepto" : "Pensión Enero", "valor" : "100.15" },
      { "concepto" : "Pensión Febrero", "valor" : "20.50" }
     ]
   }
 ]
}
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • mensaje: mensaje de la acción realizada
Ejem. Resultado: {
“resultado”:true,
“mensaje”:”Registro Actualizado Correctamente
}

Consultar valores adeudados por código de estudiante:

Como una vía  de verificación este ende point permite consultar los valores pendiente con el fin de verificar que la actualización se haya realizado correctamente a través del código de estudiante.

EndPoint:
/ext_ws/integracion_alborada/consulta_detalles_deuda_codigo/{codigo}/{api_key}
Method: GET
Params:
  • {api_key}: clave de autorización
  • {codigo}: código del estudiante
Request Ejemplo: GET
https://alborada.academi-cloud.net/ext_ws/integracion_alborada/consulta_detalles_deuda_codigo/295-E/##########
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • valor_adeudado: valor total adeudado
  • valores_pendientes: arreglo con el detalle de los valores pendientes de pago
Ejem. Resultado:
Resultado Normal:
{
 "resultado":"true",
 "valor_adeudado":"120.65",
 "valores_pendientes": [
 {
 "numero_factura" : "001-001-0003875".
 "fecha" : "01-02-2018",
 "monto_total" : "120.65",
 "detalles" : [ 
   { "concepto" : "Pensión Enero", "valor" : "100.15" }, 
   { "concepto" : "Pensión Febrero", "valor" : "20.50" } 
  ]
 }
]
}

Resultado con Error:
{"resultado":"false", "valor_adeudado":"0.00","valores_pendientes":"[]"}

Consultar valores adeudados por identificación del estudiante:

Como una vía  de verificación este ende point permite consultar los valores pendiente con el fin de verificar que la actualización se haya realizado correctamente a través del número de cédula o pasaporte del estudiante.

 

End Point: /ext_ws/integracion_alborada/consulta_detalles_deuda_identificacion/{identificacion}/{api_key}
Params:
  • {api_key}: clave de autorización
  • {identificacion}: número de cédula o pasaporte del estudiante
Request Ejemplo: GET
https://alborada.academi-cloud.net/ext_ws/integracion_alborada/consulta_detalles_deuda_identificacion/1900507409/##########
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • valor_adeudado: valor total adeudado
  • valores_pendientes: arreglo con el detalle de los valores pendientes de pago
Ejem. Resultado:
Resultado Normal:
{
 "resultado":"true",
 "valor_adeudado":"120.65",
 "valores_pendientes": [
 {
 "numero_factura" : "001-001-0003875".
 "fecha" : "01-02-2018",
 "monto_total" : "120.65",
 "detalles" : [ 
   { "concepto" : "Pensión Enero", "valor" : "100.15" }, 
   { "concepto" : "Pensión Febrero", "valor" : "20.50" } 
  ]
 }
]
}

Resultado con Error:
{"resultado":"false", "valor_adeudado":"0.00","valores_pendientes":"[]"}

Consultar Listado de Estudiantes con código, identificación 

Como un medio de consulta para que pueda verificar los estados de los estudiantes

EndPoint:
/ext_ws/integracion_alborada/buscar_estudiantes_por_periodo/{periodo}/{api_key}
Method: GET
Params:
  • {api_key}: clave de autorización
  • {periodo}: período que deseamos consultar. Ejemplo:
    • 2017 (para el período 2017 – 2018)
    • 2018 (para el período 2018 – 2019)
Request Ejemplo: GET
https://alborada.academi-cloud.net//ext_ws/integracion_alborada/buscar_estudiantes_por_periodo/2017/##########
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • detalles de los estudiante:
    • codigo
    • identificacion
    • apellidos
    • nombres
    • matricula_estado
    • curso