API rest - Header standard per il dialogo con il servizio

La comunicazione con le API del servizio prevedono il trasferimento di alcuni header "standard" durante la comunicazione.

Gli header sono di seguito descritti:

User-Agent

Header che consente l'identificazione del server, network, applicazione, sistema operativo e versione di chi sta effettuando la richiesta. (e.g. Lynfa/5.0 (Windows NT x.y; rv:10.0) Paghe/1.0)

X-App-Name

Caller application name - Le applicazioni Teamsystem hanno una nomenclatura interna così da poter essere riconosciute nel sistema. In tal caso, utilizzare il codice identificativo censito (eg. TSXYZ).

Nel caso di utilizzo da applicazioni di terze parti si prega di utilizzare un nome abbreviato che richiami appunto l'applicazione chiamante.

X-App-Version

Versione dell'applicazione che sta effettuando la chiamata (e.g. 1.0.2) 

X-Request-ID

Identificativo univoco della richiesta. E' una stringa unica che dovrebbe identificare univocamente la richiesta effettuata al servizio. Si suggerisce di utilizzare un GUID / UUID.

X-Correlation-ID

Identificativo di correlazione per richieste multimple. Tale identificativo è una stringa che consenta di correlare tra loro molteplici richieste distinte ma tra loro collegate da un contesto conosciuto dal client.

Ad esempio se la esecuzione di una operazione "client" richiede la chiamata di N chiamate distinte per completare un task è possiible utilizzare un identificativo del task come correlation-id e poi distinguere ogni singola chiamata dal request id. 

Alternativamente il correlation id può essere utilizzato per collegare le chiamate che accadono quando servizi chiamano altri servizi "in cascata". Propagando il correlation id tra i servizi sarà possibile per l'assistenza verificare la catena di chiamate effettuate e identificare più semplicemente eventuali problemi.

X-Item-ID 

Identificativo dell'item della piattaforma TSDigital che sta effettuando l'operazione

X-Manager-ID

Identificativo dell'item di TSDigital o Digital archive che gestisce l'item fornito nell'header X-Item-ID

X-User-ID

Identifier dell'utente TSDigital o Digital archive che sta effettuando l'operazione

X-Forwarded-For

Indicazione dell'IP del client che ha originato la prima chiamata. Questo header consente eventualmente la propagazione dell'identificazione dell'IP del client quando eventuali servizi vengono chiamati a cascata tra loro.

Accept-Language

Indicazione della lingua in cui il client preferisce ricevere le informazioni di ritorno. (header attualmente non significativo per Digital Archive ma introdotto per uniformità con servizi esposti da TSDigital)