Documentacion API_externa (sidcer)

Buenos días,
Descargamos correctamente la api_externa desde Colab pero no encontramos documentación de su uso , solamente un escueto Readme junto con los archivos.
Donde buscamos documentación al respecto?

Gracias

Buenos días Claudio, cual es la parte que no entienden de la documentación?
La api externa es un conjunto de archivos que te permite acceder mediante rest a unos Web Services los cuales van a pasar a sidcer algunos datos.

Saludos.

Buen día Jose,
No es que no entienda algo de la documentación, sino que no hay documentación.
Esto es todo lo que hay?

API EXTERNA =======

API para información academica del alumno.

¿Qué necesito?

  • Guaraní 3.14 o superior
  • Correr archivo diferencial.sql
  • Si posee guarani 3.14 mandar mail a guarani3@siu.edu.ar
  • composer https://getcomposer.org/

¿Instalación?

  • Ejecutar: composer install
  • Copiar el archivo parametros_template.ini a parametros.ini
  • Configurar el archivo parametros.ini
  • Copiar el archivo alias_api_template.conf a alias_api.conf
  • Configurar alias_api.conf con el alias y el path. Debe Respetar el mismo alias de parametros.ini
  • Ejecutar: ln -s /alias_api.conf /etc/apache2/sites-enabled/.conf
  • Reiniciar Apache

Datos para el SIU

  • Enviar al SIU la url pública de la presente API
  • (Recomendamos fuertemente que usen el protocolo https por sobre el http)

Aclaraciones

  • Debe quedar visible de manera pública
  • Debe tener acceso a la base de Gestión
  • Puede instalarse en el mismo servidor de Gestión o en otro

Todo eso ya se hizo, ahora como seguimos? Como se utiliza?

Al invocar vía browser /api_externa/
Esta es la salida:

{ "error": 500, "mensaje": "500 Internal Server Error", "descripcion": "Error Interno en el servidor: Este controlador no est\u00e1 configurado para manejar esta URL. La url es: '\/api_externa\/', la url de la API es '\/api_externa\/rest'" }

Gracias

Claudio, ahora que lo decís con detenimiento es verdad nos falto un ejemplo para que puedan probar esto.
La idea para probar es la siguiente:
Ingresar en la url con usuario y password suministrados en parametro.ini
/api_externa/rest/personas?pais=&tipo_documento=<tipo_documento>&numero_documento=<nro_documento>
Cuando resuelva el server esa url nos devolverá un json con el siguiente formato:

{
    "email": "guarani.siu@gmail.com",
    "telefono": "tefono",
    "persona": 13537
}

Con ese id de persona podemos ingresar a estos 2 url para también probar el servicio.
/api_externa/rest/personas/13537/datospersonales
/api_externa/rest/personas/13537/datosanalitico
Espero te ayude y resuelva tus dudas.

Saludos.

Excelente, muchas gracias

Buenos dias,

Estoy viendo este tema con la gente de sidcer, para vincular sidcer de testeo con un guarani de prueba que tenemos en la facultad de cs. agrarias, aparentemente se habia conectado bien pero cuando intentamos traer el dato de un alumno, sidcer no lo encuentra, cuando realice la consulta con la gente de sidcer, me comentan que no esta actualizado el Web Service.

La instalacion del mismo la realice de acuerdo a lo que esta especificado en la documentacion de SIU, me podrian dar una mano por favor identificando el problema?

Muchas gracias por la ayuda.

Guillermo.

Buenas tardes Guillermo, si probás con algún dato real que exista en esa base, y te devuelve algo, entonces tu WS estará funcionando correctamente.
Ahora sino funciona lo vemos.

Saludos.

Hola Jose,

Reitero el mensaje anterior:

aparentemente se habia conectado bien pero cuando intentamos traer el dato de un alumno, sidcer no lo encuentra

No trae ningun dato, dice que no lo encuentra.

Saludos.

Hola,

Ya encontramos lo que pasa, no hace la redireccion y no pone el rest, o sea basicamente no funciona la regla que reescribe la url:
http://xxx.xxxx.xxxx.xxxx/apisidcer/personas?pais=54&tipo_documento=0&numero_documento=xxxxxxx

Si ponemos la url con el rest funciona:
http://xxx.xxx.xxx.xxx/apisidcer/rest/personas?pais=54&tipo_documento=0&numero_documento=xxxxxxx

Estoy viendo de corregir el alias_api.conf, pero por ahora no he tenido suerte.

Gracias.

Guillermo.

Hola,

Ya lo hicmos andar.

Muchas gracias.

Guillermo.

Buenísimo Guillermo.

Saludos.