API INPS

API INPS

Le specifiche Application Programming Interface (API) dell'INPS descrivono un set di funzioni che consentono agli utenti di interagire con il DataCatalog Opendata. Insieme al portale Opendata, dove è possibile recuperare le risorse open distribuite come files di download (xls, csv, xml, json, owl), le API permettono un accesso veloce alla lista completa dei dataset, dei relativi metadati e dei dati. Gli sviluppatori web possono utilizzare le richieste di accesso per avere le informazioni aggiornate giornalmente a supporto dei propri applicativi. Le condizioni di accesso alle risorse dati sono definite della licenza IODL2.0 associata a ciascun dataset con la cui applicazione si incoraggia il riuso, la distribuzione, e la creazione di lavori derivati dall'utilizzo dei dati pubblicati.

Richieste base

Per accedere alle funzionalità REST-based è necessario comporre una chiamata HTTP GET costruendo la URL. Le chiamate API supportano i seguenti parametri:

• Package_list - La chiamata restituisce l'indice di tutti i dataset del catalogo, ovvero l'elenco dei rispettivi ID.
  https://serviziweb2.inps.it/odapi/package_list
• Package_show - La chiamata restituisce l'estrazione di tutti i metadati e i formati di distribuzione riguardanti il dataset identificato da un ID numerico.
  https://serviziweb2.inps.it/odapi/package_show?id={id-dataset}
• Current_package_list_with_resources - La chiamata restituisce una copia dell'intero datacatalog INPS, ovvero tutti i metadati relativi ai dateset INPS. Supporta parametri limit ed offset per paginare.
  https://serviziweb2.inps.it/odapi/current_package_list_with_resources?limit=50
• Bulk - La chiamata restituisce una copia di tutto il datastore INPS comprensivo sia dei dati che dei metadati relativi a ciascun dataset.
  https://serviziweb2.inps.it/odapi/bulk?limit=50
• Bulk download - La chiamata restituisce una copia di tutto il datastore INPS comprensivo sia dei dati che dei metadati relativi a ciascun dataset, come file di download. Supporta parametri limit ed offset per paginare.
  https://serviziweb2.inps.it/odapi/bulk_download?limit=50
• Status - La chiamata restituisce le informazioni sullo stato della piattaforma API e dei servizi erogati.
  https://serviziweb2.inps.it/odapi/status

Formato di Risposta

Tutte le request restituiscono output in formato JSON. Per visualizzare in modo più chiaro l'output, è possibile incollare la risposta all'interno del JSON LINT validator. Le chiavi del JSON sono in linea con la v.3 delle API CKAN.
Le due request di bulk sfruttano il JSON-LD (JSON for Linked Data) per esprimere i vocabolari semantici utilizzati nel modello metadati degli Opendata INPS. Il vocabolario DCAT e FOAF e Dublin Core descrivono la struttura del datacatalog, i metadati e le informazioni di provenance per garantire la trasparenza dell'Istituto. 
La chiamata di status, sempre in JSON, restituisce informazioni sulla versione API attualmente attiva, il count dei bulk download e relativa dimensione. Sono anche definite le informazioni sulla frequenza di aggiornamento del datacatalog in versione cron per una più comoda pianificazione periodica dei comandi in ambiente Unix.
Per avere indicazioni tecniche su come utilizzare le API si può consultare la pagina: https://www.dati.gov.it/content/sviluppatori