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

User agent string (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

Caller application version (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 correlate per un contesto conosciuto dal client. Ad esempio se la esecuzione di una operazione "client" richiede la chiamata di N chiamate distinte