Les APIs són interfícies que especifiquen com els diferents components de programes informàtics haurien d'interaccionar. Es tracta d'un conjunt de funcions i procediments oferts per ser utilitzats per un altre programa per tal d'interactuar amb el programa en qüestió. Podem distingir diversos tipus d'APIs disponibles al portal.

APIs de gestió del catàleg

Aquesta API serveix per consultar i gestionar la informació del catàleg, com datasets, recursos, etiquetes, etc.

Es tracta de l'API que ofereix la tecnologia CKAN per tal de gestionar el catàleg de datasets. A aquesta API s'accedeix des d'aquesta URL, a la qual s'ha d'afegir el nom del mètode a què volem accedir.

Aquesta API pot tenir interès per a la ciutadania per conèixer quina informació es troba disponible al portal TGN Dades Obertes i els datasets que es van afegint. 

La crida a aquests mètodes no requereix l'ús d'un token ni cap altre mètode d'identificació, són mètodes públics.

Exemples d'aquests mètodes són els següents:

• current_package_list_with_resources: retorna la llista de datasets actuals i els seus recursos
• package_search: fa una cerca dins del catàleg de datasets
• resource_show: retorna les metadades d'un recurs

APIs de consulta sobre recursos CSV

Permet consultar i filtrar la informació continguda dins d'un CSV concret APIs pròpies de l'Ajuntament. Són APIs habilitades per les pròpies fonts d'informació i desenvolupades a mida.

El filtre API CKAN disponible permet seleccionar els datasets amb aquesta interfície habilitada.

Aquestes interfícies permeten actuar sobre un recurs CSV concret. Per tal que la plataforma mostri aquest servei, el recurs s'ha de pujar al portal TGN Dades Obertes amb un format i codificació adequats. Quan es puja un CSV a la plataforma, es crea de manera interna una taula a base de dades d'aquest recurs. Aquest emmagatzemament dins de CKAN s'anomena datastore. L'API del datastore ens permet fer consultes directament sobre aquestes taules.

Cal destacar que la utilització de l'API de consulta és un recurs CSV individual, no de dataset del catàleg.

Més Informació de l'API

Podeu accedir a la documentació completa de l'APi de dades i datastore.