Utilizzo dell’API CKAN

CKAN- API
- Prerequisiti per l’utilizzo dell’API
Come trovare l’ultima versione di una risorsa?

CKAN- API

“CKAN è la soluzione software leader per la costruzione di portali di dati aperti. Il CKAN supporta l’amministrazione nella centralizzazione delle attività relative ai dati aperti, catalogazione, versionamento, archiviazione e registrazione dei dati pubblicati.”

Prerequisiti per l’utilizzo dell’API

È necessario saper leggere JSON.
Dovreste aver compreso i principi di base delle API REST.
Si dispone di una chiave API dal cruscotto per sviluppatori.

Come trovare l’ultima versione di una risorsa?

Utilizziamo come esempio “orario-2016-hrdf” (orario del periodo). È anche possibile cercare gli altri possibili record di dati utilizzando la query “package_list” (vedere sotto).

È necessario prendere le deviazioni tramite i passaggi 3 e 4 perché gli ID delle risorse cambiano a ogni raccolta. Ogni risorsa ha sempre un ID risorsa unico.

Svolgimento:

Utilizzare l’API CKAN
Trovare lo slug del dataset (qui ‘timetable-2016-hrdf’) o in generale cercarlo con https://api.opentransportdata.swiss/ckan-api/package_list.
Leggere il contenuto del set di dati https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf
Ricerca all’interno delle risorse. È necessario caricare l’orario periodico più recente. L’attualità può essere determinata dalla data (YYYY-MM-DD) nel campo “url”.

{
   "license_title":"Andere (Offen)",
   "resources":[
      //…Other ressource
      {
         "byte_size":13851261,
         "coverage":"Coverage",
         // lot of attributes
         "title":"{\"fr\": \"Periodic timetable 2016 (HDRF)\", \"de\": \"Periodic timetable 2016 (HDRF)\", \"en\": \"Periodic timetable 2016 (HDRF)\", \"it\": \"Periodic timetable 2016 (HDRF)\"}",
         // lots of attributes
         "url":"https://data.opentransportdata.swiss/dataset/9f0babdc-0bdb-4400-b6fa-fd6d1f11cd5d/resource/e521f5d9-7f42-446f-9746-29ba2c26dfd8/download/fp20162016-09-24.zip",
         // lots of things
//
}

{

"license_title":"Andere (Offen)",

"resources":[

//…Other ressource

{

"byte_size":13851261,

"coverage":"Coverage",

// lot of attributes

"title":"{\"fr\": \"Periodic timetable 2016 (HDRF)\", \"de\": \"Periodic timetable 2016 (HDRF)\", \"en\": \"Periodic timetable 2016 (HDRF)\", \"it\": \"Periodic timetable 2016 (HDRF)\"}",

// lots of attributes

"url":"https://data.opentransportdata.swiss/dataset/9f0babdc-0bdb-4400-b6fa-fd6d1f11cd5d/resource/e521f5d9-7f42-446f-9746-29ba2c26dfd8/download/fp20162016-09-24.zip",

// lots of things

}

Con l’URL (‘url’) è possibile scaricare il file
Si noti che l’orario del periodo successivo è sempre disponibile intorno a novembre (l’orario annuale è disponibile prima). Altri record di dati come Didok rimangono e sono indipendenti dall’anno di orario.

Importante da sapere

La CKAN-API non è stata progettata per carichi molto pesanti: in altre parole, non utilizzate la CKAN-API come un data warehouse, ma per interrogazioni occasionali e per l’identificazione automatica delle risorse da scaricare.

Altri metadati

È inoltre possibile ottenere tutti gli altri metadati rilevanti dei dati tramite https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf.

I dettagli relativi a una singola risorsa sono elencati anche nell’elemento risorse.

Accesso ai singoli elementi dei dati

L’accesso ai singoli campi è descritto utilizzando lo pseudo-servizio Didok.

Ulteriori indicazioni