API per ricerca dati

CKAN.

Il portale open data del Comune di Ferrara è basato su CKAN ed espone interfacce API che consentono l’accesso e l’interrogazione delle informazioni attraverso richieste che forniscono risultati formattati in JSON. Attraverso le API è possibile fare ricerche per accedere al catalogo completo di dati riguardanti un determinato argomento oppure aventi una specifica parola chiave, ottenere le descrizioni dei dati ed effettuare lo scarico dei dati stessi.

Per i dataset pubblici non è necessaria alcuna autenticazione.

I seguenti metodi servono per ottenere gli elenchi di dati, gruppi e parole chiave usate
presenti nel catalogo:
• https://dati.comune.fe.it/api/3/action/package_list: restituisce la lista completa di tutti i dati open (per ciascun risultato viene mostrato solo l’id del dataset)
• https://dati.comune.fe.it/api/3/action/group_list: restituisce l’elenco dei gruppi (cioè le 13 categorie tematiche previste da AgID per i dati open)
• https://dati.comune.fe.it/api/3/action/tag_list: restituisce l’elenco completo di tutte le parole chiave (tag) usate nel catalogo

Per ottenere le schede descrittive dei dati, è invece possibile utilizzare i seguenti metodi (per ciascun metodo è riportato un esempio pratico):
• https://dati.comune.fe.it/api/3/action/package_show?id=nido: questo esempio mostra in formato JSON la scheda descrittiva completa (metadato) relativa al dataset con id = “nido”; nella scheda sono riportate tutte le informazioni previste dallo standard nazionale DCAT-AP_IT
• https://dati.comune.fe.it/api/3/action/package_search?q=aria: questo esempio mostra la risposta JSON ad una ricerca per parola chiave libera (es. “aria”) con l’elenco di tutti i risultati che soddisfano la ricerca; per ciascun risultato è riportata la scheda descrittiva del dataset (metadato)
• https://dati.comune.fe.it/api/3/action/resource_search?query=format:WFS: questo esempio mostra la risposta JSON ad una ricerca per formato della risorsa
(es. “WFS”); per formato della risorsa si intende il formato fisico o il protocollo con cui è possibile accedere o scaricare il dato
• https://dati.comune.fe.it/api/3/action/resource_search?query=name:PM10: questo esempio mostra la risposta JSON ad una ricerca per nome della risorsa (PM10)

Per maggiori informazioni sull'utilizzo delle API si consiglia di fare riferimento alla documentazione ufficiale CKAN.