API pubbliche CKAN

Questa sezione è rivolta ai cittadini, alle imprese e alle pubbliche amministrazioni che intendono accedere e consultare i metadati del Catalogo Dati Puglia. 

Il Catalogo supporta le Application Programming Interface (API) del sistema CKAN.   

I metodi, opportunamente richiamati, restituiscono i risultati delle consultazioni in formato in JSON, come previsto dalla direttiva europea n. 1024 del 2019. 

 Il percorso (path) da interrogare tramite le API di CKAN è https://dati.puglia.it/ckan/

 

Metodi disponibili

 

Metodo package_list / package_show

Package_list mostra l'elenco di tutti i dataset presenti nel catalogo
Es. https://dati.puglia.it/ckan/api/3/action/package_list 
Package_show?id={id-dataset} permette l'acquisizione dei metadati del singolo dataset
Es. https://dati.puglia.it/ckan/api/3/action/package_show?id=elenco-strutture-ricettive 
Nota: tramite la chiamata del metodo package_list è possibile risalire agli id dei singoli 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: 
https://dati.puglia.it/ckan/api/3/action/current_package_list_with_resources?limit=10 
oppure 
Dati di tipo aperto: https://dati.puglia.it/ckan/api/3/action/current_package_list_with_resources?limit=10&offset=50 
Si suggeriscono, per motivi di performance, chiamate di massimo 100 record per volta (limit=100). 

 

Metodo package_search

Effettua una ricerca fra tutti i dataset che abbiano un dato valore per un campo specificato. Per i Dati di tipo aperto: https://dati.puglia.it/ckan/api/3/action/package_search?facet.field=[%22holder_name%22]&facet.limit=-1&fq=holder_name:%22ARTI%20Puglia%22 

 

Organization_list e Organization_show

Le chiamate al Catalogo Dati Puglia https://dati.puglia.it/ckan/api/3/action/organization_list consentono di ottenere la lista dei cataloghi esposti mentre l'interrogazione puntuale del catalogo è possibile, rispettivamente, con https://dati.puglia.it/ckan/api/3/action/organization_show?id={id-catalogo} 
Es.: https://dati.puglia.it/ckan/api/3/action/organization_show?id=arti-puglia  

 

Approfondimenti 

Per approfondire l'uso delle API di CKAN, consulta la documentazione completa di CKAN .