Diferencia entre revisiones de «SIU-Guarani/Version3.19.0/API REST GUARANI»
| (No se muestran 7 ediciones intermedias de otro usuario) | |||
| Línea 8: | Línea 8: | ||
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. [[SIU-Guarani/version3.19.0/instalacion_desde_cero/instalacion/gestion/linux|Link a los pasos del proceso de instalación del sistemas]].<br> | 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. [[SIU-Guarani/version3.19.0/instalacion_desde_cero/instalacion/gestion/linux|Link a los pasos del proceso de instalación del sistemas]].<br> | ||
| − | + | === Configuración Técnica de la API (Usuarios y Perfil Funcional) === | |
| + | |||
| + | 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 recomienda tener diferentes usuarios para los sistemas Kolla, Tehuelche, Sanaviron-Quilmes, 3W y SICer.<br /> | ||
| + | El formato es: | ||
| + | <syntaxhighlight lang="bash" enclose="div" highlight="4"> | ||
| + | [<usuario_externo>] | ||
| + | password = <pass_usuario_externo> | ||
| + | </syntaxhighlight> | ||
| + | '''<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>. | ||
| + | |||
| + | [[Archivo:GUA_configuracion_api_1.png]]<br><br> | ||
| + | |||
| + | Así mismo, se deberá crear el archivo <code><path_gestion>/php/rest/recursos_usuarios.php</code> a partir de su respectivo template <code><path_gestion>/php/rest/recursos_usuarios_template.php</code> (el mismo es un archivo autodocumentado).<br /> | ||
| + | Y se deben agregar los usuarios que se configuraron en el paso anterior (<code><path_gestion>/instalacion/i__desarrollo/p__guarani/rest/servidor_usuarios.ini</code>). | ||
| + | |||
| + | [[Archivo:GUA_configuracion_api_2.png]]<br><br> | ||
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 [[SIU-Guarani/version3.19.0/interfaces/gestion-3w-rest| este link]].<br> | 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 [[SIU-Guarani/version3.19.0/interfaces/gestion-3w-rest| este link]].<br> | ||
| Línea 14: | Línea 32: | ||
== Servicios contenidos en la API == | == Servicios contenidos en la API == | ||
| − | El listado completo de los webservices de la API pueden verlos en este link. <br> | + | El listado completo de los webservices de la API pueden verlos en este link: https://documentacion.siu.edu.ar/apis/?spec=guarani_v1. <br> |
== Personalización de la API == | == Personalización de la API == | ||
| − | ¿Necesitás crear nuevos servicios REST? Mira esta documentación para saber cómo hacer esta personalización.<br> | + | ¿Necesitás crear nuevos servicios REST? Mira [[SIU-Guarani/Version3.19.0/personalizaciones/rest| esta documentación]] para saber cómo hacer esta personalización.<br> |
| − | [[SIU-Guarani/ | + | [[SIU-Guarani/version3.19.0/interfaces|< Volver]] |
Revisión actual del 10:55 2 dic 2022
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
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 (Usuarios y Perfil Funcional)
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.
