Diferencia entre revisiones de «SIU-Guarani/Version3.20.0/API REST GUARANI»
m |
|||
Línea 4: | Línea 4: | ||
Durante el proceso de instalación y configuración del módulo será necesario configurar qué usuarios se conectarán con el módulo a través de la API <br> | Durante el proceso de instalación y configuración del módulo será necesario configurar qué usuarios se conectarán con el módulo a través de la API <br> | ||
− | '''NOTA:''' A partir de la versión 3.20.0 la API REST pasa a versionarse, y sera accedida a través de la URL ''http://< | + | '''NOTA:''' A partir de la versión 3.20.0 la API REST pasa a versionarse, y sera accedida a través de la URL ''http://<url_gestion>/rest/v1/''. |
== Configuración de la API-REST == | == Configuración de la API-REST == | ||
Línea 11: | Línea 11: | ||
=== Configuración Técnica de la API === | === Configuración Técnica de la API === | ||
+ | |||
+ | |||
+ | Se debe configurar el archivo <code><path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor.ini</code> para la definición de las rutas de las versiones de la API REST: | ||
+ | |||
+ | <syntaxhighlight lang="bash" enclose="div" highlight="4"> | ||
+ | [<usuario_externo>] | ||
+ | password = <pass_usuario_externo> | ||
+ | </syntaxhighlight> | ||
Se debe configurar el archivo <code><path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor_usuarios.ini</code> para la definición de usuarios que consumirán la API REST SIU-Guaraní. | Se debe configurar el archivo <code><path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor_usuarios.ini</code> para la definición de usuarios que consumirán la API REST SIU-Guaraní. |
Revisión del 10:49 20 oct 2021
Sumario
API-REST Guaraní
La API REST de SIU-Guaraní engloba un conjunto de servicios que utiliza el módulo para comunicarse (transferir o consumir datos) con otros sistemas.
Durante el proceso de instalación y configuración del módulo será necesario configurar qué usuarios se conectarán con el módulo a través de la API
NOTA: A partir de la versión 3.20.0 la API REST pasa a versionarse, y sera accedida a través de la URL http://<url_gestion>/rest/v1/.
Configuración de la API-REST
La configuración de la API es uno de los pasos detallados en el proceso de instalación del sistema. Más precisamente ocupa el paso n° 12 del mismo. Link a los pasos del proceso de instalación del sistemas.
Configuración Técnica de la API
Se debe configurar el archivo <path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor.ini
para la definición de las rutas de las versiones de la API REST:
password = <pass_usuario_externo>
Se debe configurar el archivo <path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor_usuarios.ini
para la definición de usuarios que consumirán la API REST SIU-Guaraní.
Se recomienda tener diferentes usuarios para los sistemas Kolla, Tehuelche, Sanaviron-Quilmes, 3W y SICer.
El formato es:
password = <pass_usuario_externo>
<usuario_externo>: Usuario para consumir la API REST SIU-Guaraní, ej: ue_kolla para un usuario de Kolla que quiera consumir la API REST SIU-Guaraní. <pass_usuario_externo>: Password del usuario <usuario_externo>.
Así mismo, se deberá crear el archivo <path_gestion>/php/rest/recursos_usuarios.php
a partir de su respectivo template <path_gestion>/php/rest/recursos_usuarios_template.php
(el mismo es un archivo autodocumentado).
Y se deben agregar los usuarios que se configuraron en el paso anterior (<path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor_usuarios.ini
).
También será necesario configurar la API para poder comunicar los módulos de gestión y autogestión. Para realizar esta configuración consultar este link.
Servicios contenidos en la API
El listado completo de los webservices de la API pueden verlos en este link: https://documentacion.siu.edu.ar/apis/?spec=guarani_v1.
Personalización de la API
¿Necesitás crear nuevos servicios REST? Mira esta documentación para saber cómo hacer esta personalización.