API

Data di aggiornamento

Questa sezione è rivolta ai cittadini, alle imprese ed alle pubbliche amministrazioni interessate ad utilizzare i metadati del Catalogo attraverso le API.

Il portale supporta le API di CKAN che possono essere utilizzate attraverso richieste che forniscono i risultati formattati in JSON.

Attraverso le API è possibile interrogare il CKAN contenente gli Open Data della PA. Per indirizzare la richiesta occorre quindi usare il seguente basePath:

•    CKAN Opendata: https://dati.gov.it/opendata/

Tra le API di CKAN sono disponibili:

Metodo package_list / package_show

Questo metodo permette l'interrogazione dell'indice di tutti i record, tramite le  chiamate al Catalogo per i dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/package_list,
per poi fare interrogazioni puntuali ai singoli record con la chiamata https://www.dati.gov.it/opendata/api/3/action/package_show?id={id-dataset}.

Per esempio, dalla lista dei dataset per accedere ai metadati del singolo dataset, può essere utilizzata la chiamata https://www.dati.gov.it/opendata/api/3/action/package_show?id=qualita-dei-corsi-di-studio.

Passando, in questo caso, il "parametro id" ricavato dalla lista degli id restituiti dalla chiamata package_list è possibile acquisire i metadati del singolo dataset.

Metodo current_package_list_with_resources

Un altro metodo disponibile è la chiamata current_package_list_with_resources, che restituisce un array di oggetti di tipo dataset con tutti i campi disponibili. 

La chiamata richiede un argomento limit (obbligatorio) ed - opzionalmente - un campo offset (di default = 0).

Per esempio:

oppure 

Attenzione: per questioni di performance si suggerisce di effettuare chiamate di massimo 100 record per volta (limit=100).

Informazioni del catalogo

La chiamata al Catalogo https://www.dati.gov.it/opendata/api/3/action/organization_list consente di ottenere la lista dei cataloghi esposti mentre l’interrogazione puntuale del catalogo è possibile con https://www.dati.gov.it/opendata/api/3/action/organization_show?id={id-catalogo}.

Per esempio, dalla lista dei cataloghi, per accedere alle informazioni del singolo catalogo, può essere utilizzata la chiamata https://www.dati.gov.it/opendata/api/3/action/organization_show?id=comune-di-milano.

Lista amministrazioni 

La chiamata al Catalogo https://www.dati.gov.it/opendata/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1  consente di ottenere la lista delle amministrazioni con il rispettivo conteggio dei dataset.

Un importante servizio è quello che permette di cercare tutti i dataset che abbiano un dato valore per un campo specificato: https://dati.gov.it/opendata/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1&fq=holder_name:"ACI"

Altri metodi e parametri

Per maggiori informazioni sull’utilizzo delle API di CKAN per la consultazione del catalogo fai riferimento alla documentazione di CKAN