Introduzione
Documentazione delle API di XOX.
Autorizzazione
Ci sono tre modalità di autorizzazione alle chiamate:
- tramite identificazione IP
- tramite copia di chiavi inviate nell'header di ogni chiamata. Le 2 chiavi si
devono chiamare:
- SyncPublicKey: la chiave pubblica
- SyncSecretKey: la chiave segreta
- tramite access token generato da login inviato nell'header di ogni chiamata.
L'header da inviare è il seguente:
- AccessToken: token di accesso
Parametri standard per tutte le chiamate in lettura
Tutte le richieste vengono effettuate con il method POST e i parametri vengono
passati come oggetto JSON nel body della richiesta.
| Field | Type | Required | Default | Description | Notes |
|---|---|---|---|---|---|
PageSize |
int |
❌ | 100 |
Numero di elementi per pagina | |
Page |
int |
❌ | 1 |
Numero pagina | |
Date |
DateTime |
❌ | null |
Data ultima modifica | Restituisce gli elementi modificati dalla data indicata |
Risposta standard per le chiamate in lettura
| Field | Type | Description | Notes |
|---|---|---|---|
statusCode |
int |
stato della risposta | 200 - esito positivo; 403 - non autorizzato; 400 - parametri non validi; 500 - Errore interno |
errorCode |
string |
codice specifico errore | presente solo in caso di statusCode 400,403 e 500 |
message |
string |
descrizione dell'errore | presente solo in caso di statusCode 400,403 e 500 |
result |
Array |
Risultato della richiesta. Un array di oggetti specifici della richiesta | |
debug |
Debug |
Informazioni di debug | Viene esposto solo se viene passato il parametro GET debug=true |
Debug
| Field | Type | Description | Notes |
|---|---|---|---|
RequestTime |
DateTime |
Data e ora inizio elaborazione richiesta | |
ResponseTime |
DateTime |
Data e ora fine elaborazione richiesta | |
Duration |
TimeSpan |
Durata elaborazione richiesta | |
ClientIP |
string |
IP dal quale viene effettuata la richiesta |
IN QUESTA PAGINA