2.6. Aspetti legati all’azienda erogatrice delle API

Si riportano nella tabella seguente i campi del descrittore dell’API che indirizzano direttamente gli aspetti legati all’azienda erogatrice dell’API.

2.6.1. Gli aspetti relativi all’azienda all’interno del descrittore dell’ API

Campi del descrittore relativi all’azienda erogatrice dell’API
Campo Descrizione
Anagrafica dell’API

Attributi di descrizione anagrafica dell’API:

  1. Nome dell’ API: nome univoco dell’API all’interno dell’Ecosistema.
  2. Descrizione dell’API: descrizione sintetica in testo libero dell’API, la quale fornisce una presentazione funzionale dell’API.
  3. Versione del descrittore: indicazione della versione del descrittore.
  4. Tag per classificazione dell’API: insieme di parole chiave che consentono di classificare l’API.
  5. Eventuali ulteriori vincoli specifici in ingresso e in uscita dall’API: Eventuali ulteriori vincoli che è necessario conoscere / rispettare per utilizzare l’API.
  6. Estensione geografica contenuti dell’API: indicazione dell’estensione geografica dei dati restituiti dall’API (utile a favorirne la ricerca).

2.6.2. Linee Guida per la gestione degli aspetti relativi all’azienda

Il descrittore dell’API rappresenta uno strumento fondamentale non solo per documentare gli aspetti di tipo tecnologico legati all’erogazione di una API, ma anche per indirizzare tematiche di tipo organizzativo e di relazione tra l’API Provider e l’Ecosistema.

Per questo motivo, all’interno del descrittore devono essere indicati:

  • i principali attributi di tipo anagrafico dell’API (nome API, descrizione, nome API provider, versione, tag per classificazione ecc.), importanti al fine di consentire una comprensione generale dell’API anche da parte di interlocutori non tecnici; tali attributi hanno una valenza importante anche a scopo di comunicazione (alcuni attributi di anagrafica delle API saranno infatti resi visibili pubblicamente sui registri di E015 Digital Ecosystem anche da parte di soggetti non aderenti all’iniziativa); in particolare, la descrizione dell’API fornita all’interno del descrittore deve consentire di comprendere al meglio le caratteristiche funzionali dell’API ed il valore potenziale per i soggetti che ne intendono fare uso;
  • i riferimenti (nome, cognome, e-mail, numero di telefono) del referente dell’API nei confronti dell’Ecosistema. Tale referente deve avere compreso a pieno le logiche di E015 Digital Ecosystem e deve essere il punto di contatto per il TMB qualora vi fosse la necessità di indirizzare alcune tematiche di interesse legate all’erogazione dell’API. Le informazioni relative al referente dell’API non saranno rese visibili agli App Provider, ma sono da intendersi ad uso esclusivo del TMB.

2.6.3. Linee Guida per la pubblicazione sul proprio sito web istituzionale delle informazioni sulle API di E015 Digital Ecosystem

Una volta pubblicato una API all’interno dell’Ecosistema, l’API Provider deve prevedere sul proprio sito web istituzionale una sezione dedicata alla descrizione dell’iniziativa di partecipazione all’Ecosistema e alla descrizione delle API pubblicate con un link che rimanda al sito web dell’Ecosistema, per il dettaglio delle informazioni delle API pubblicate.

La presenza o meno di tali informazioni all’interno del sito web istituzionale del API Provider sarà oggetto di verifica da parte del TMB e rappresenterà un aspetto di interesse ai fini dell’accettazione o meno della richiesta di pubblicazione di una nuova API.