2. Descrittore dell’API

L’elemento cardine per la pubblicazione delle API all’interno di E015 Digital Ecosystem è rappresentato dal “Descrittore dell’API”. Il “Descrittore dell’API” indirizza nel suo complesso tematiche di tipo tecnologico – per consentire l’integrazione delle API all’interno delle applicazioni –e fornisce numerose informazioni sull’API, tenendo in considerazione aspetti di tipo organizzativo e di policy che regolamentano l’utilizzo dell’API stessa. In Figura 2.1 sono riportate tutte le caratteristiche necessarie alla documentazione delle API condivise all’interno dell’Ecosistema, da dettagliare nel documento specifico.

_images/dimensioniinteresse.png

Figura 2.1: Dimensioni di interesse per la descrizione delle API di E015 Digital Ecosystem

È necessario che ognuna di queste dimensioni sia adeguatamente documentata affinché una API possa essere pubblicata all’interno dell’Ecosistema. Di seguito un breve riassunto delle dimensioni di interesse indirizzate dal “Descrittore dell’API”:

  • Aspetti di interoperabilità: rientrano in questa categoria tutti gli aspetti di tipo tecnico necessari per poter invocare le API pubblicate all’interno dell’Ecosistema ed integrarle all’interno delle Applicazioni (per esempio, la documentazione dell’interfaccia dell’API);
  • Accesso sicuro alle API: rientrano in questa categoria tutti gli aspetti tecnologici ed organizzativi necessari per la gestione degli aspetti di sicurezza legati all’erogazione delle API (ad esempio, per la restrizione dell’accesso alle API ai soli soggetti autorizzati da parte dell’API Provider, per mezzo di uno specifico meccanismo in seguito denominato “meccanismo di attestazione”);
  • Glossari delle API: aspetti di documentazione legati al modello dei dati gestiti dalla API (entità, concetti e loro rappresentazione);
  • Aspetti di monitoraggio delle API: rientrano in questa categoria tutti gli aspetti necessari affinché E015 Digital Ecosystem sia in grado di monitorare costantemente la disponibilità delle API messe a disposizione da parte degli API Provider;
  • Aspetti correlati all’erogazione delle API: rientrano in questa categoria gli aspetti riguardanti eventuali “Logiche di remunerazione” correlate all’utilizzo delle API e gli aspetti di “Qualità” di erogazione delle API;
  • Aspetti legati all’azienda: rientrano in questa categoria gli aspetti di tipo organizzativo e di comunicazione, correlati all’erogazione delle API (es: referente dell’API verso E015 Digital Ecosystem);
  • Policies delle API: sezione del descrittore riportante i termini e le condizioni di utilizzo con cui sono esposte le API sull’Ecosistema e che ciascun soggetto utilizzatore dell’API si deve impegnare a rispettare nei confronti dell’API Provider.

Nei prossimi paragrafi vengono forniti tutti i dettagli e le indicazioni operative per indirizzare ciascuna di queste dimensioni.