Context
Per facilitar la integració d’AiDA amb altres sistemes i aplicacions, s’ha publicat una API al API Manager que permet consultar de forma programàtica les dades gestionades per l’aplicació (Seccions de DA específics, informació sobre aplicacions…). Aquesta API està pensada perquè qualsevol projecte que ho requereixi pugui donar-se d’alta com a consumidor i obtenir accés a les dades d’AiDA’ sense necessitat d’interactuar directament amb l’aplicació.
Funcionalitats bàsiques
- Consulta de les dades introduïdes en cada secció dels DA.
- Consulta de l’estat, nom i versió dels DA.
- Consulta de les plantilles d’arquitectura associades a cada DA (Cloud Privat, Cloud Públic, Low Code…).
Passos per consumir l’API des de l’API Manager
Per poder consumir l’API d’AiDA cal seguir els següents passos:
- Crear una app al portal de consumidors Accedir al portal de consumidors de l’API Manager de CTTI i crear una nova aplicació (app), que serà la que s’utilitzarà per sol·licitar l’accés a l’API: https://portal.db40-c57f0fcb.eu-de.apiconnect.appdomain.cloud/ctti/public/
- Sol·licitar la consumició de l’API Des de la mateixa app creada, sol·licitar la consumició (subscripció) al producte/API d’AiDA publicat a l’API Manager (3731 AiDA)
- Contactar amb l’equip d’AiDA per obtenir les credencials Una vegada sol·licitada la consumició, cal contactar amb l’equip d’AiDA a través del correu aida.dadigital@gencat.cat, indicant el nom de l’app creada i el projecte/equip sol·licitant, perquè es puguin facilitar les credencials necessàries per completar l’alta com a consumidor.
- Realitzar les crides a l’API Amb la subscripció aprovada i les credencials facilitades, ja es poden realitzar les crides a les diferents operacions publicades. La documentació detallada de cada endpoint (paràmetres, exemples de resposta, etc.) es troba disponible a: https://out.apps.gencat.cat/DA_API/rest/GetDAInfo/#/GetDAInfo
Evolució de l’API
L’API d’AiDA es troba en constant evolució. A mesura que sorgeixin noves necessitats, s’aniran afegint noves operacions que permetin consultar dades addicionals de l’aplicació.
Si algun projecte necessita una operació que actualment no estigui disponible, es pot fer arribar la proposta a través del correu aida.dadigital@gencat.cat, indicant la necessitat concreta, per tal de valorar-ne la incorporació en properes versions de l’API.