API rest - Digital Archive - Intro
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 Rest - Autenticazione su Digital Archive
API per la consultazione dei documenti
Le API per la consultazione dei documenti sono volte a ricercare le diverse entità presenti nel sistema.
- API Rest - Lettura documenti da processare
- API Rest - Lettura documenti conservati
- pacchetto di versamento [da realizzare]
- pacchetto di archiviazione [da realizzare]
- pacchetto di distribuzione [da realizzare]
API per la scrittura
Documentazione swagger per ilIl versamento dei documenti TODO:può mettereessere ileffettuato seguendo le specifiche descritte nella documentazione associata e disponibile al link a prod quando disponibile
Le API perrest la- conservazioneVersamento deinuovi documenti sono volte a processare le entità:
TODO: in teoria sono la stessa entità, le teniamo separate o fa confusione?
Struttura del pacchetto di input
Le informazioni contenute nell'entità che deve essere caricata a sistema sono le seguenti:
Struttura del pacchetto di input rettificante
Le informazioni dell'entità di rettifica di un pacchetto di input sono le medesime dell'entità base, a cui vanno aggiunte le informazioni sulla rettifica:conservare
Come risposta alle azioni di versamento e rettifica di un documento si avrà un identificativo univoco relativo all'entità pacchetto di input.