Sviluppare o integrare applicazioni con i dati del Portale

21 luglio 2015
Dati per gli sviluppatori

La tecnologia di accesso ai dati è basata sullo stile REST Representational State Transfer, derivato dal protocollo HTTP, e le interfacce API che trattano le richieste mediante i comandi GET, POST, PUT, DELETE e supportano il formato dei dati JSON e XML.
Tutte le funzioni disponibili hanno una propria URI e possono essere invocate indipendentemente, offrendo agli sviluppatori una scelta flessibile di funzionalità, da integrare secondo una loro logica applicativa.
Con l'Open Service ci si apre inoltre alla possibilità non solo di utilizzare i dati messi a disposizione a runtime dall'ente, ma si vuole aprire alla possibilità, da parte di applicazione terze,  di eseguire dei comandi per aggiornare il dato stesso o aggiungerne di nuovi.
La risorsa rappresenta la funzionalità o l'insieme dei dati e/o servizi resi a disposizione attraverso tale interfaccia. Ogni risorsa è individuata attraverso una URI univoca che ne permette l'accesso attraverso i suddetti metodi GET, POST, PUT, DELETE, che rappresentano rispettivamente le operazioni di -estrazione-, -aggiunta-, -modifica- e -cancellazione- del singolo dato gestito.

Non tutti i metodi sono sempre disponibili le risorse pubblicate.

Il metodo GET è quello che viene utilizzato per poter esporre la risorsa in formato aperto: ogni dato ricavato attraverso questo metodo, può essere fornito in un formato a scelta.

Descrizione delle risorse

Per ogni singola risorsa esposta viene documentata:

  • la URI univoca, di solito composta dalla combinazione di una URL base, di un namespace e del nome della risorsa;
  • la descrizione della risorsa
  • i formati disponibili XML e JSON
  • la modalità di accesso dei possibili metodi di accesso GET, POST, PUT e DELETE

Per ognuno dei metodi disponibili viene indicata:
  • la descrizione
  • la policy di accesso, ovvero se il metodo è pubblico o meno, se è necessaria un'autenticazione, se è necessaria un'autorizzazione specifica oltre all'autenticazione
  • lo schema xml della chiamata per i metodi POST e PUT e della risposta per tutti i metodi)
  • la lista dei parametri (la chiave, la descrizione e obbligatorietà se richiesta).

Nella pagina dei Servizi Open Service disponibili sul portale viene riportato l'elenco delle risorse e la struttura delle chiamate web possibili che l'interfaccia API può accettare.