Diferencia entre revisiones de «SIU-Kolla/Version 3.6.0/interfaces»
(Página creada con «__NOTOC__ derecha|link=SIU-Kolla/version3.6.0») |
(→Servicios Web) |
||
| (No se muestran 13 ediciones intermedias de 2 usuarios) | |||
| Línea 1: | Línea 1: | ||
| − | + | __TOC__ | |
[[Archivo:siu-kolla_iso.png|derecha|link=SIU-Kolla/version3.6.0]] | [[Archivo:siu-kolla_iso.png|derecha|link=SIU-Kolla/version3.6.0]] | ||
| + | |||
| + | == Introducción == | ||
| + | |||
| + | Para lograr una comunicación con otros módulos, SIU-Kolla ofrece diferentes servicios web a través de su API para la manipulación de entidades básicas. En algunos casos, lo servicios solo involucran la recuperación de datos, y otros ofrecen un CRUD (Create-Retrieve-Update-Delete). | ||
| + | |||
| + | == Configuración == | ||
| + | |||
| + | Para poder utilizar los Servicios Web, se debe dar de alta el usuarios como Sistema Externo, y posteriormente, configurar dicho usuario en la configuración REST del proyecto: | ||
| + | |||
| + | === Creación de usuario como Sistema Externo === | ||
| + | |||
| + | La siguientes operaciones deben ser realizadas por un usuario con los permisos suficientes. | ||
| + | |||
| + | ''Para registrar un Sistema Externo visite la siguiente [[SIU-Kolla/Version 3.6.0/Documentacion de las operaciones/menu usuarios sistemas externos|página]]'' | ||
| + | === Creación de usuario REST === | ||
| + | * Editar el archivo <tt><path proyecto Kolla>/instalacion/i__<instancia>/p__kolla/rest/servidor.ini</tt> | ||
| + | <source lang="php" enclose="div"> | ||
| + | ;servidor.ini | ||
| + | autenticacion = basic | ||
| + | </source> | ||
| + | * y <tt><path proyecto Kolla>/instalacion/i__<instancia>/p__kolla/rest/servidor_usuarios.ini</tt> | ||
| + | <source lang="php" enclose="div"> | ||
| + | ;servidor_usuarios.ini | ||
| + | [<nombre de usuario>] | ||
| + | password = sP6lgHwQopaqepOzgIWw ;cambiar! | ||
| + | </source> | ||
| + | * Se debe reemplazar: | ||
| + | ** <path proyecto Kolla>: por el path donde se encuentra instalado el proyecto SIU-Kolla | ||
| + | ** <instancia>: por el nombre de la instancia | ||
| + | |||
| + | Para más información, consultar en la explicación de [https://toba.siu.edu.ar/trac/toba/wiki/Referencia/Rest REST de Toba] | ||
| + | |||
| + | == Servicios Web == | ||
| + | # [[SIU-Kolla/Version 3.6.0/WS/Conceptos|Conceptos]] | ||
| + | # [[SIU-Kolla/Version 3.6.0/WS/Elementos|Elementos]] | ||
| + | # [[SIU-Kolla/Version 3.6.0/WS/Encuestas|Encuestas]] | ||
| + | # [[SIU-Kolla/Version 3.6.0/WS/Habilitaciones|Habilitaciones]] | ||
| + | # [[SIU-Kolla/Version 3.6.0/WS/Tipo Elemento|Tipo Elemento]] | ||
| + | |||
| + | == Posibles errores en las peticiones == | ||
| + | |||
| + | * '''400''': Errores de validación. Uno o más atributos de la entidad que se quiere guardar no paso la validación. El servicio retorna un arreglo con la descripción de cada uno de los errores. | ||
| + | * '''404''': Usualmente ocurre cuando el recurso que se intenta manipular o recuperar no existe. Podrá sera cualquiera de las entidades involucradas (Por ejemplo, la [[SIU-Kolla/Version 3.6.0/Glosario de conceptos#U|Unidad de Gestión]] no existe). | ||
| + | * '''500''': Error interno en el servidor, deberá revisarse el mensaje enviado al cliente. | ||
| + | |||
| + | <br> | ||
| + | [[SIU-Kolla/version3.6.0 | < Volver ]] | ||
Revisión actual del 10:26 4 may 2016
Sumario
Introducción
Para lograr una comunicación con otros módulos, SIU-Kolla ofrece diferentes servicios web a través de su API para la manipulación de entidades básicas. En algunos casos, lo servicios solo involucran la recuperación de datos, y otros ofrecen un CRUD (Create-Retrieve-Update-Delete).
Configuración
Para poder utilizar los Servicios Web, se debe dar de alta el usuarios como Sistema Externo, y posteriormente, configurar dicho usuario en la configuración REST del proyecto:
Creación de usuario como Sistema Externo
La siguientes operaciones deben ser realizadas por un usuario con los permisos suficientes.
Para registrar un Sistema Externo visite la siguiente página
Creación de usuario REST
- Editar el archivo <path proyecto Kolla>/instalacion/i__<instancia>/p__kolla/rest/servidor.ini
;servidor.ini
autenticacion = basic
autenticacion = basic
- y <path proyecto Kolla>/instalacion/i__<instancia>/p__kolla/rest/servidor_usuarios.ini
;servidor_usuarios.ini
[<nombre de usuario>]
password = sP6lgHwQopaqepOzgIWw ;cambiar!
[<nombre de usuario>]
password = sP6lgHwQopaqepOzgIWw ;cambiar!
- Se debe reemplazar:
- <path proyecto Kolla>: por el path donde se encuentra instalado el proyecto SIU-Kolla
- <instancia>: por el nombre de la instancia
Para más información, consultar en la explicación de REST de Toba
Servicios Web
Posibles errores en las peticiones
- 400: Errores de validación. Uno o más atributos de la entidad que se quiere guardar no paso la validación. El servicio retorna un arreglo con la descripción de cada uno de los errores.
- 404: Usualmente ocurre cuando el recurso que se intenta manipular o recuperar no existe. Podrá sera cualquiera de las entidades involucradas (Por ejemplo, la Unidad de Gestión no existe).
- 500: Error interno en el servidor, deberá revisarse el mensaje enviado al cliente.
