API rest

Introduzione

Le API per l'inserimento e la consultazione sono raggiungibili attraverso due servizi distinti. Di seguito è fornito il dettaglio di ciascun servizio.

Autenticazione

Attualmente il sistema Digital Archive ha una propria anagrafica e un proprio sistema di autenticazione attraverso token. Sono però in corso dei lavori per la migrazione verso TS Digital sia lato anagrafiche che lato sistema di autenticazione. Detto questo, attualmente le API funzionano con token generato dal sistema Digital Archive.

API per la lettura

Le API per la consultazione dei documenti sono volte a ricercare le entità:

pacchetto di input da processare
pacchetto di input conservato
pacchetto di versamento [da realizzare]
pacchetto di archiviazione [da realizzare]
pacchetto di distribuzione [da realizzare]

Struttura del pacchetto di input da processare

Struttura del pacchetto di input conservati

Il pacchetto di input è l'entità l'utente carica a sistema e che deve essere poi conservata. Le informazioni in essa contenute sono le seguenti:

metadati generici: quali id del documento ed altre informazioni utili al sistema
pdv: pacchetto di versamento a cui il pacchetto di input fa riferimento
pda: pacchetto di archiviazione a cui il pacchetto di input fa riferimento
file: informazioni relative al file versato
holder: titolare al quale il documento fa riferimento
submitter: produttore che ha versato il documento
anno_riferimento: anno o esercizio del documento fondamentale per calcolare il tempo di conservazione
details: metadati inseriti dall'utente in fase di versamento

Documentazione swagger per i documenti da processare TODO: mettere il link a prod quando disponibile

Documentazione swagger per i documenti conservati TODO: mettere il link a prod quando disponibile