Le API di OpenCoesione

Cosa è l'API di OpenCoesione?

L'API di OpenCoesione è un'interfaccia applicativa che permette a qualunque componente software esterno di accedere ai dati di OpenCoesione.
I componenti software possono essere sviluppati da terze parti, utilizzando qualsiasi tecnologia. Si veda oltre per il tipo di licenza d'uso legata ai dati.
L'API di OpenCoesione adotta l'architettura REST.

 

Chi può accedervi e come?

Tutti possono accedere alla API, partendo dalla url http://www.opencoesione.gov.it/api.
L'API è navigabile con i browser (Internet Explorer, Firefox, Safari, Chrome, ...) attraverso dei link ipertestuali, come un normale sito web.
E' possibile accedere con un utenza anonima o una registrata. Entrambe le tipologie di utenze possono accedere a tutti i dati, ma le limitazioni sul numero di richieste per minuto sono differenti. Si veda la domanda sulle limitazioni più oltre.
Per ottenere una username e password, basta contattarci inviando una email all'indirizzo info@opencoesione.gov.it.

 

In che formato sono disponibili i dati?

I dati sono disponibili in formato HTML e in formato JSON.
Il formato HTML permette la navigazione tra i dati e la visualizzazione della documentazione integrata (in lingua inglese), che descrive l'utilizzo avanzato, a beneficio degli sviluppatori.
Il formato JSON è invece di facile interpretazione da parte dei software, rimanendo comunque leggibile.
Le risorse sono presentate in formato HTML, se non altrimenti specificato e per accedere al formato JSON di una risorsa, basta aggiungere .json.

Un esempio:

  • http://opencoesione.gov.it/api/progetti (HTML)
  • http://opencoesione.gov.it/api/progetti.json (JSON)

 

Quali dati sono disponibili?

Sono esposte queste risorse principali:

  • Progetti - Elenco dei progetti, filtrabili per tema, natura o territorio
  • Soggetti - Elenco dei soggetti, filtrabili per tema e ruolo
  • Aggregati - Informazioni aggregate, rispecchiano le informazioni mostrate nelle pagine del sito.

Per semplificare il lavoro degli sviluppatori, sono disponibili anche degli elenchi accessori:

  • Nature - Elenco delle nature dei progetti
  • Temi - Elenco dei temi dei progetti
  • Territori - Elenco dei territori
  • Programmi - Elenco dei programmi operativi
  • Classificazioni - Elenco classificazioni del QSN

 

Esistono limitazioni nel numero di richieste per minuto?

Gli utenti anonimi possono effettuare dodici richieste al minuto, mentre per gli utenti autenticati, questo limite sale a una richiesta al secondo (60 al minuto).

 

Che licenza d'uso hanno i dati?

Tutti i dati sono sono rilasciati con licenza CC BY-SA 3.0.

 

E' disponibile una documentazione dettagliata?

Sì, navigando la API attraverso un browser, per ogni risorsa sono indicati i filtri e gli ordinamenti disponibili e sono illustrate le modalità con cui gli sviluppatori possono accedere alle informazioni necessarie.

La documentazione online, avendo come target un audience di programmatori, possibilmente di differenti nazionalità, è disponibile esclusivamente in lingua inglese.