STG: Implementació API Rest SISTRAGES

[sgelabert-dgtic]

Es continua amb la implementació de l'API interna el tiquet #28 :

• Documentació de l'API amb Swagger
• Implementació dels serveis interns : [descripció]

[sgelabert-dgtic]

D'acord amb el document de disseny tècnic el context d'accés a l'API interna és: /sistrages/api/rest/interna i veig que en el web.xml està securitzat amb el rol STG_API_INT i que funciona correctament si s'empra l'usuari de WS $sistramit_sistrages, però quin seria el context d'accés a la documentació amb al swagger-editor?

[sgelabert-dgtic]

En quan a l'API interna de SISTRAGES:

/sistrages/api/rest/interna/entidad/{id}

• El backoffice i l'API retornen com "identificador" de l'entitat el codi DIR3, però l'operació de consulta empra l'identificador intern (ENT_CODIGO) de BBDD. A través del backoffice, no podem consultar l'id de l'entitat en cap lloc (aniria bé que es presentés com a camp protegit). El JSON de retorn, tampoc figura l'id intern de l'entitat.

/sistrages/api/rest/interna/entidad/{id}/avisos

• No funciona, retorna sempre una llista buida d'avisos, quan el backoffice n'hi ha de definits.
• Els avisos són multi-idioma, per tant, entenc que faltaria el paràmetre idioma sistrages/api/rest/interna/entidad/{id}/avisos/{idioma}
• Segurament hauríem de poder treure els avisos d'una versió de tràmit concreta sistrages/api/rest/interna/tramite/{idTramite}/{version}/avisos/{idioma}, no?

/sistrages/api/rest/interna/dominioFuenteDatos/{idDominio}

• Desconec l'estructura del JSON amb el paràmetres per fer petició POST. Pendent de provar-ho amb swagger

/sistrages/api/rest/interna/entidad/1/permisosHelpdesk

• Dóna un 404

Entenc que l'API s'anirà completant en funció de les necessitats dels altres mòduls. A priori hagués definit altres operacions que no figuren a l'API. A més cal veure si la granularitat d'operacions com /rest/interna/tramite/{idTramite}/{version}/{idioma} és adequada o ens convé segmentar-ho afegint un paràmetre de pas de tramitació, per exemple.

[sgelabert-dgtic]

El commit https://github.com/GovernIB/sistra2/commit/e6568716435705d44e11e4dc7dbb6ad5022f044e relacionat amb el tiquet #29 "Implementació del workflow de tramitació II" conté codi d'implementació de l'API SISTRAGES. Per favor, intentau relacionar els commits amb les incidències, si no és molt difícil dur-ne el seguiment.

[rsanz-indra]

Por error se comiteo asociado a la issue que no tocaba. Todos esos cambios son de esta issue.

[jsastre-dgtic]

No ens funciona: http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/dominioFuenteDatos/CIUTATS

Request method 'GET' not supported

http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/emtidad/A04003003/permisosHelpdesk http://sdevapplin5.caib.es:48080/sistrages/api/rest/externa/tramite

Forbidden

La resta de serveis de l'API si ens ha respost de manera correcta.

[dmadronal-indra]

Buenas,

• http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/dominioFuenteDatos/CIUTATS: Tal como indica el mensaje esta petición no se puede realizar por GET, en este caso debe realizarse por POST. Por otro lado para que la consulta retorne datos se debe consultar un dominio de fuente de datos, y el que se esta consultando es de tipo lista.

• http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/emtidad/A04003003/permisosHelpdesk: Referente a esta petición, ¿nos podéis indicar en que os habéis basado para formarla? A priori no esta contemplada en el api interna. También hemos visto que la palabra emtidad debería ser entidad. ¿Es posible que la url que estáis buscando sea esta url http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/entidad/A04003003/avisos?

• http://sdevapplin5.caib.es:48080/sistrages/api/rest/externa/tramite: Esta url no esta bien formada, la palabra externa debería ser interna y se le deben añadir los parametros correctos. Sería algo asi http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/tramite/{idTramite}/{version}/{idioma}-->http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/tramite/SA001/1/es

[jsastre-dgtic]

1.- Ok, ara el problema és que no aconseguim crear una Font de Dades:

[dmadronal-indra]

Buenas, Antes de crear un dominio que consuma una fuente de datos, es necesario crear la fuente de datos, y al crear el dominio es necesario indicar la fuente, en este caso al no existir ninguna no puede seleccionar una por defecto. Este error parece darse solo si no se ha creado ninguna fuente de datos, añadiremos un control para evitarlo. Si probáis creando primero la fuente de datos debería ir bien. ¿lo podéis verificar?

[jsastre-dgtic]

Creant abans la Font de Dades si ens deixa. Però el servei dóna error...

<body>Internal Server Error</body>

[jsastre-dgtic]

Al document: [(https://github.com/GovernIB/sistra2/blob/sistra2-1.0/doc/pdf/SISTRA2_DisenyoTecnico.pdf)] A la pàgina 12: http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/entidad/A04003003/permisosHelpdesk

I a la pàgina 14: http://sdevapplin5.caib.es:48080/sistrages/api/rest/externa/tramite

(Si posam "http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/tramite/SA001/1/ca", funciona bé)

[dmadronal-indra]

Referente a la consulta del error al consultar la fuente de datos, el dominio dado de alta no incluye ninguna consulta por lo que, segun parece, es normal que no retorne resultados, si se incluye una consulta valida debería funcionar.

Referente a las funcionalidades indicadas del API Interna de STT sólo están implementados los servicios necesarios para la integración dº (STT--> STG), que es la integración que se ha puesto en marcha. En este ciclo se ha definido el módulo API Rest para STT, se han implementado las funciones necesarias y se ha puesto en marcha la integración con STG. Cuando se comience con el STH se implementarán dichos servicios. Respecto al API Externa tampoco está planificada todavía la implementación.

[jsastre-dgtic]

1. Amb una QUERY= SELECT ID, DESC FROM CIUTATS, seguim obtenint error. Tampoc podem fer un ping, ni estam segurs del pseudollenguatge.... ens comentau com fer-ho?

Internal Server Error

2.- Ok 3.- Ok

[amaciam-indra]

Hola,

Amb la URL http://sdevapplin5.caib.es:48080/sistrages/api/rest/interna/dominioFuenteDatos/DOMINICIUTATS sí que obtenim una reposta:

{ "datos": [ { "ID": "01", "DESC": "Palma" }, { "ID": "02", "DESC": "Inca" } ], "error": false, "codigoError": null, "descripcionError": null, "numeroFilas": 2, "nombreColumnas": [ "ID", "DESC" ] }

Respecte al ping, aquesta funcionalitat encara no està implementada, tal i com indica la propia aplicació amb un alert.

[jsastre-dgtic]

OK, ja me funciona! Gràcies

[jsastre-dgtic]

En poder compilar acabam de provar el nou control per a crear font de dades...

[jsastre-dgtic]

Falta el control, segueix llençant error: "Antes de crear un dominio que consuma una fuente de datos, es necesario crear la fuente de datos, y al crear el dominio es necesario indicar la fuente, en este caso al no existir ninguna no puede seleccionar una por defecto. Este error parece darse solo si no se ha creado ninguna fuente de datos, añadiremos un control para evitarlo."

[amaciam-indra]

Ho revisam i miram d'incorporar el control per no permetre guardar un domini de font de dades si no s'indica una font de dades associada. Aquest control s'implementarà en el proper cicle.

[jsastre-dgtic]

ok, si no vos queda res pendent de consulta podem tancar la issue... ens ho confirmau?

[amaciam-indra]

confirmat, podeu tancar