Vés al contingut (premeu Retorn)

Sou a: Inici / API d'indicadors TIC / Documentació / Manual d'usuari

Manual d'usuari

Indicadors TIC és l'API de publicació i consulta d'indicadors dels diferents serveis TIC de la UPC.

Mètodes exposats per l'API

L'API exposa mètodes per als serveis, indicadors i categories de cada indicador. Podeu definir diferents categories per a cada indicador, cadascuna d'elles amb el seu valor.

L'API treballa amb  contracte JSON comú mitjançant el qual tots els clients consumeixen i publiquen indicadors.

Podeu consultar i provar els mètodes de l'API a l'entorn de test.  

Arquitectura de l'API

Podeu consultar l'arquitectura de sistema de l'API dins l'apartat de documentació tècnica

Aportar els indicadors de un SI a l'API d'Indicadors

Els sistemes d'informació que vulguin proveir  indicadors seran clients proveïdors de l'API i implementaran  crides POST a l'API les quals permeten persistir els indicadors dins la BBDD d'indicadors de l'API.

Els clients proveïdors  també poden fer crides PUT i DELETE per modificar i esborrar els indicadors a l'API (exemple: myList, EquipsTIC, ...)


Cada sistema d'informació proveïdor d'indicadors s'encarrega d'implementar en el seu sistema la lògica de negoci  per obtenir els indicadors i cridar als mètodes GET de l'API.

Obtenir la informació dels indicadors

Els sistemes d'informació que volen obtenir la informació dels indicadors són clients consumidors  de l'API.

L'API exposa mètodes GET per obtenir els indicadors TIC dels sistemes d’informació així com la identificació de cadascun dels sistemes. Tots els indicadors s'obtenen amb els mateixos mètodes i mitjançant un punt únic de petició. Cada sistema consumidor és l'encarregat d'interpretar i fer el tractament adient dels indicadors.


Mètodes exposats per l'API

L'API exposa mètodes per als serveis, indicadors i categories de cada indicador. Podeu definir diferents categories per a cada indicador, cadascuna d'elles amb el seu valor. Podeu consultar i provar els mètodes de l'API a l'entorn de test.  

 

Històric dels indicadors

En la seva versió inicial l'API no emmagatzema l'estat dels indicadors i per tant no ofereix la consulta de l'històric d'indicadors. 

 

API i  SOA

L'API està publicada al catàleg de serveis SOA UPC.  El bus SOA no enruta la versió inicial de l'API.