top of page

English version

Sviluppare con le WEB API

Scoperta e accesso

Introduzione

Il termine Web API è utilizzato genericamente per riferirsi a qualche implementazione di una interfaccia di programmazione per applicazioni Web. Come tale, una Web API può essere un’API RESTful o una libreria implementata in qualche linguaggio di programmazione per il Web. L’ENERGIC OD VH utilizza il termine Web API in questo ultimo significato per identificare una libreria Javascript che facilita lo sviluppo di applicazioni Web e mobili utilizzando le capacità del VH.

La Web API è quindi una libreria Javascript che fornisce un insieme di oggetti software predefiniti le cui proprietà e comportamento nascondono la complessità dell’interazione con il VH, mostrando allo sviluppatore solamente i metodi significativi.

La Figura 9 mostra il principali oggetti dell’API Web e il loro comportamento in una tipica applicazione:

 

  • DAB: è il punto di ingresso della Web API. Questo oggetto rappresenta il componente del VH (discovery and access broker) che è in grado di accedere fonti eterogenee di dati in modo omogeneo. Durante la fase di creazione, l’oggetto DAB è associato ad una specifica istanza del VH (per esempio il VH italiano). L’oggetto DAB forinisce la capacità di trovare dataset rilevanti accessibili mediante il VH.

  • ResultSet: ggetto restituito come risultato di un’operazione discovery dell’oggetto DAB. Rappresenta un insieme di dataset che corrispondono ai vincoli di ricerca specificati nella discovery.

  • Paginator: oggetto associato automaticamente a ResultSet e che consente di recuperare i risultati come pagine contenenti sottoinsiemi dei risultati (Pages). Aiuta a gestire i risultati evitando liste troppo lunghe.

  • Page: oggetto che rappresenta un sottoinsieme di un ResultSet.

  • GINode: oggetto che rappresenta una risorsa di geoinformazione (tipicamente un dataset) che è il singolo risultato di un’operazione discovery del DAB e parti di una Page.

  • Layer: oggetto che rappresenta un dataset pronto per l’utilizzo da parte di altre librerie javascript e ambienti come OpenLayers.

Figure 9 I principali concetti rappresentati come oggetti nella Web API

Il metodo discover dell’oggetto DAB permette di recuperare l’oggetto ResultSet che contiene tutti gli oggetti GINode che soddisfano i criteri specificati nell’oggetto JSON passato alla chiamata discover. L’accesso agli oggetti GINode è mediato dall’oggetto Paginator, collegato a ResultSet, che permette di accedere insiemi limitati di GINodes come Pages. Il contenuto di ogni GINode può essere acceduto come Layer di diverse tipologie.


La documentazione completa della Web API disponibile online (http://api.eurogeoss-broker.eu/docs/index.html) fornisce una descrizione dettagliata degli oggetti, delle loro proprietà e metodi, e include esempi e dimostrazioni.

E' possibile vedere un esempio di utilizzo delle Web API per il Virtual Hub italiano qui

bottom of page