Sviluppatori

Data di aggiornamento
Venerdì 21 Maggio 2021

Questa sezione è rivolta ai cittadini, alle imprese ed alle pubbliche amministrazioni interessate ad utilizzare i metadati dei Cataloghi, rispettivamente dei Dati di tipo aperto (Open Data) e delle Basi di Dati della PA, 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 sia il CKAN contente gli Opendata sia il CKAN contenente le Basi di Dati della PA. Per indirizzare la richiesta occorre quindi usare due diversi basePath:

•    CKAN Opendata: https://dati.gov.it/opendata/
•    CKAN Basi di Dati: https://dati.gov.it/base-dati/

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 ai rispettivi Cataloghi, per i Dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/package_list e per le Basi di Dati della PA https://www.dati.gov.it/base-dati/api/3/action/package_list,
per poi fare interrogazioni puntuali ai singoli record con
le rispettive chiamate, per i Dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/package_show?id={id-dataset} e per le Basi di Dati della PA https://www.dati.gov.it/base-dati/api/3/action/package_show?id={id-dataset}.

Per esempio, dalla lista dei dataset per accedere ai metadati del singolo dataset, può essere utilizzata per i Dati di tipo aperto la chiamata https://www.dati.gov.it/opendata/api/3/action/package_show?id=qualita-dei-corsi-di-studio e per le Basi di Dati della PA la chiamata https://www.dati.gov.it/base-dati/api/3/action/package_show?id=sistema-di-gestione-delle-presenze.

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, rispettivamente per i due Cataloghi:

oppure 

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

Informazioni dei cataloghi

Le chiamate ai rispettivi Cataloghi, per i Dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/organization_list e per le Basi di Dati della PA https://www.dati.gov.it/base-dati/api/3/action/organization_list, consentono di ottenere la lista dei cataloghi esposti mentre l’interrogazione puntuale del catalogo è possibile, rispettivamente, con https://www.dati.gov.it/opendata/api/3/action/organization_show?id={id-catalogo} per i Dati di tipo aperto e https://www.dati.gov.it/base-dati/api/3/action/organization_show?id={id-catalogo} per le Basi di Dati.

Per esempio, dalla lista dei cataloghi, per accedere alle informazioni del singolo catalogo, possono essere utilizzate, rispettivamente, le chiamate per i Dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/organization_show?id=catalogo-federato-salento-jonico e per le Basi di Dati della PA https://www.dati.gov.it/base-dati/api/3/action/organization_show?id=accademia-della-crusca.

Lista amministrazioni 

Le chiamate ai rispettivi Cataloghi, per i Dati di tipo aperto https://www.dati.gov.it/opendata/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1 e per le Basi di Dati della PA https://www.dati.gov.it/base-dati/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1, consentono 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. Per i Dati di tipo aperto https://dati.gov.it/opendata/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1&fq=holder_name:"ACI" e per le Basi di Dati della PA https://dati.gov.it/base-dati/api/3/action/package_search?facet.field=["holder_name"]&facet.limit=-1&fq=holder_name:"Accademia della Crusca"

Altri metodi e parametri

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