API

 

Quando nel presente contesto si parla di API (Application Programming Interface, Interfaccia di Programmazione di una Applicazione) se ne parla nel senso di API web, cioè di servizi web che abilitano altri programmi ad interagire con il repertorio degli open data. In particolare, il portale offre dei servizi web di tipo RESTful che, rispetto ai classici servizi SOAP o ad altre tecnologie, sono molto più facili da utilizzare da parte delle applicazione client, siano esser delle normali applicazioni web o mobili. Le API REST sono caratterizzate dall'essere servizi orientati alle risorse e, per il portale open data, le risorse sono soprattutto  i "dataset" e le "risorse" (nel senso dei tangibili componenti dei dataset), o meglio, i metadati che li descrivono. Così abbiamo API per aggiungere nuovi dataset al catalogo o per cambiare alcuni attributi che descrivono una risorsa o ricercare una particolare parola chiave o recuperare tutti gli attributi di un specifico dataset, giusto per fare alcuni esempi.

In generale, tutto ciò che si può fare nel catalogo attraverso l'interfaccia uomo, può essere fatto usando le API con soltanto alcune piccole eccezioni e con le stesse considerazioni di sicurezza, cioè che alcune API richiedono un'autorizzazione. La ricerca e la visualizzazione o il download sono ovviamente disponibili liberamente.

Queste API consentono di interagire con i metadati del catalogo, ma è possibile avere a che fare con i dati mediante un'interfaccia applicativa oppure si è obbligati a scaricarli per poterli usare? Ci sono API anche per i dati, ma siccome c'è molta varietà tra i dati stessi, è presente una corrispondente varietà di API. Ci sono API RESTful per dati alfanumerici, servizi OGC per i dati spaziali e un endpoint SPARQL per i linked data.

Quando si usano i dati alfanumerici, si possono ricercare, filtrare e consultare i dati senza bisogno di scaricare l'intera risorsa del dataset. Lo stesso vale per i servizi OGC, che, anche se non sono RESTful, seguono uno standard internazionale molto diffuso e utilizzato e che può essere usato anche per produrre immagini georeferenziate. L'endpoint SPARQL consente di interrogare i linked data e scaricarli applicando dei filtri e delle operazione di selezione.

 

Gli sviluppatori possono accedere al catalogo utilizzando le API, un modo alternativo per interfacciarsi col portale dati.lazio.it. 

L'indirizzo per accedere alle API è il seguente: http://dati.lazio.it/catalog/api/3
Le API vengono fornite da CKAN e tutte le istruzioni per l'utilizzo sono fornite al seguente indirizzo: http://docs.ckan.org/en/ckan-2.0.2/api.html.