API Matricole

Cosa permette di fare

L'API Matricole consente a un sistema esterno di:

Consultare l'elenco delle matricole (numeri seriali) presenti su Areagate, con possibilita' di filtrare per ID, serial number, codice host o cliente
Sincronizzare le matricole modificate dopo un determinato momento
Inserire o aggiornare matricole in modo massivo

Versioni

L'API e' disponibile in due versioni:

v1: la chiave di identificazione e' il numero seriale (serialNumber). Il cliente e' obbligatorio.
v2: la chiave di identificazione e' il codice host (codiceHost). Supporta il collegamento alla merce. Il cliente e' opzionale.

Consultazione matricole

Lista matricole

Permette di ottenere l'elenco delle matricole attive. E' possibile filtrare per:

ID: ricerca esatta per ID interno
Serial number: ricerca esatta per numero seriale
Codice host: ricerca esatta per codice host (solo v2)
Cliente: ricerca per codice cliente

I risultati sono impaginati (massimo 200 per pagina).

Per ogni matricola vengono restituiti, oltre ai dati principali: modello, merce, marca, tipo, date di garanzia, anno di costruzione, dati dell'utilizzatore (nome, indirizzo, localita', CAP, provincia, nazione) e il codice host del gruppo aziende.

Matricole aggiornate

Permette di ottenere solo le matricole che sono state modificate dopo un determinato punto di sincronizzazione. Utile per mantenere allineato un sistema esterno senza dover rileggere tutte le matricole ogni volta.

Inserimento e aggiornamento matricole

Il sistema esterno puo' inviare un elenco di matricole da inserire o aggiornare. Per ogni matricola:

Se la chiave (serial number in v1, codice host in v2) non esiste su Areagate, la matricola viene creata
Se la chiave esiste e i dati sono diversi, la matricola viene aggiornata
Se la chiave esiste e viene indicata come cancellata, la matricola viene disattivata

Dati gestibili

I dati principali che possono essere inviati per ogni matricola:

Numero seriale, codice host modello, descrizione
Codice host cliente, anno di costruzione
Date di inizio e fine garanzia (in formato epoch millisecondi)
Codice host utilizzatore, flag prototipo
Codice host gruppo aziende
Codice host merce (solo v2)

Date garanzia

Le date di garanzia devono essere inviate come timestamp in millisecondi (epoch ms). Il sistema le converte automaticamente nel formato interno.