Il set di API indicate come Import avanzato e raccolte, nello swagger, sotto il tag ALL (Scrittura) rappresentano il canale ufficiale attraverso cui software esterni possono scrivere dati all'interno di PEOPLELINK. Si tratta di tre endpoint che lavorano in sequenza e in modo asincrono, formando un flusso completo: scoperta della struttura dati, invio dei dati, monitoraggio dell'elaborazione.

Il principio architetturale di fondo è la generalità: anziché esporre un endpoint per ogni entità, viene offerto un unico punto di ingresso capace di gestire tipologie di import diverse, differenziate dal codice implementativo impl passato nella chiamata. Questo riduce la superficie dell'API pubblica e uniforma il comportamento per tutti i moduli.

Flusso operativo

Il flusso inizia con GetJsonExample, un endpoint di supporto che restituisce un template JSON completo per la tipologia di import desiderata. Il template include i nomi di tutti i fogli previsti, le colonne necessarie e dati mock di esempio. Può essere ottenuto in formato grezzo con commenti esplicativi oppure come JSON valido e immediatamente utilizzabile. Questo endpoint elimina la necessità di consultare documentazione esterna: il contratto dati è autodocumentato e sempre aggiornato.

Una volta costruito il JSON con i dati reali, si procede con SendJson, il cuore del sistema. L'endpoint riceve un body strutturato a fogli, dove ogni foglio rappresenta una categoria di dati e contiene una lista di righe, ognuna a sua volta composta da celle chiave-valore. Prima di qualunque elaborazione, il sistema esegue una pre-validazione sincrona: se il JSON è malformato o contiene errori strutturali, la risposta lo segnala immediatamente senza accodare nulla. Se invece la validazione ha esito positivo, l'import viene messo in coda per l'elaborazione asincrona e viene restituito un identificativo univoco. Il comportamento in caso di sovrapposizione con dati già presenti è controllabile tramite due parametri: l'algoritmo di upsert aggiorna i record esistenti identificandoli univocamente, mentre il flag di upsert parziale permette di scegliere se sovrascrivere il record per intero o aggiornare soltanto i campi effettivamente presenti nel JSON. Per alcuni import, è possibile indicare anche un algoritmo di post-elaborazione specifico, da eseguire al termine dell'import. La gestione è ALL-OR-NOTHING: se anche un solo record presenta un errore in fase di elaborazione, l'intero import viene annullato e nulla viene scritto sul database.

Una volta ottenuto l'identificativo dell'import, il chiamante deve interrogare CheckState per sapere come procede l'elaborazione. L'endpoint riceve l'ID e il codice di tipologia, e restituisce uno stato che può essere: completato con successo, in errore, ancora in coda, oppure sconosciuto. In caso di errore, viene fornita la lista dei messaggi di dettaglio generati durante l'elaborazione, utili per diagnosticare il problema e correggere i dati prima di un nuovo invio.

Parametri in Request da utilizzare con l'import

impl è il parametro che identifica la tipologia di import da eseguire. Ogni valore numerico corrisponde a una specifica entità del sistema e determina quale struttura dati viene attesa nel body, quali validazioni vengono applicate e su quali tabelle di PEOPLELINK verranno scritti i dati. È obbligatorio sia in SendJson che in CheckState, perché il sistema non ha modo di inferire autonomamente di quale entità si tratti. In sostanza, è la chiave che disambigua il comportamento dell'endpoint unico: lo stesso SendJson si comporta in modo completamente diverso a seconda del valore di impl passato.

alg definisce la strategia con cui il sistema gestisce i dati in ingresso rispetto a quelli già presenti sul database. Il valore 1, detto algoritmo di startup, esegue un inserimento diretto senza verificare se esistono già record equivalenti: va usato esclusivamente in fase di prima installazione o in scenari in cui si è certi dell'assenza di duplicati, perché non offre alcuna protezione contro la creazione di record sovrapposti. Il valore 2, detto algoritmo di upsert, è quello pensato per l'uso ordinario: il sistema cerca di identificare univocamente ogni record in ingresso e, se lo trova già presente, lo aggiorna; se non lo trova, lo inserisce come nuovo. Questo approccio è però applicabile solo alle entità che dispongono di un identificativo univoco stabile, poiché senza di esso il sistema non è in grado di stabilire se un record esista già o meno.

partialupsert entra in gioco esclusivamente quando si utilizza l'algoritmo di upsert (alg=2) e controlla la profondità dell'aggiornamento in caso di sovrapposizione. Con il valore false, che è il comportamento predefinito, l'aggiornamento è totale: il record esistente viene completamente riscritto con i dati del JSON, e i campi non presenti nella chiamata vengono azzerati o riportati al valore di default. Con il valore true, l'aggiornamento è invece parziale: vengono toccati soltanto i campi esplicitamente presenti nel JSON, lasciando invariati tutti gli altri. La scelta tra i due comportamenti dipende dall'intenzione del chiamante: se si vuole sincronizzare completamente un record lo si imposta a false, se si vuole aggiornare solo alcuni attributi senza rischiare di perdere dati già presenti lo si imposta a true.

postelab è un parametro opzionale che permette di agganciare, al termine dell'import, un algoritmo di post-elaborazione specifico, cablato all'interno del software PEOPLELINK. Se non viene valorizzato, l'import si conclude con la sola scrittura dei dati. Se invece viene indicato un valore riconosciuto dal sistema, al completamento dell'import viene eseguita automaticamente una logica aggiuntiva configurata lato server, tipicamente utile per aggiornare strutture derivate, ricalcolare aggregati o innescare processi consequenziali all'inserimento dei dati. I valori ammessi non sono liberi ma predefiniti: dipendono dalla tipologia di import (impl) e dalla configurazione dell'installazione.

Conseguentemente a quanto sopra riportato si ricorda che:

·         la lista di tutte le tipologie di import disponibili è consultabile direttamente nello swagger e viene aggiornata ad ogni rilascio

·         l'algoritmo di startup è sempre disponibile per tutti gli import. La disponibilità o meno dell'algoritmo di upsert è indicata nel template JSON di esempio.

Correlazione tra import multipli con l'header X-PL-SyncId

X-PL-SyncId è un header HTTP opzionale, ma fortemente consigliato, che il client genera autonomamente e passa nella chiamata a SendJson. Il valore atteso è un GUID, ma non ci sono specifiche stringenti.

La sua funzione è di correlazione: quando un import logicamente unitario viene spezzato in più chiamate a SendJson - ad esempio, perché il client decide di inviare un'entità alla volta invece che in batch - passando lo stesso GUID in tutte le chiamate si comunica al sistema che quelle operazioni fanno parte di uno stesso contesto. Questo permette di tracciarle e riconciliarle insieme lato PEOPLELINK, anziché trattarle come import indipendenti e scollegati.

Non è quindi un meccanismo di idempotenza nel senso stretto del termine, ovvero non impedisce la doppia esecuzione di una stessa chiamata in caso di retry. Il suo scopo è semantico: fornire un filo conduttore tra operazioni distinte che il chiamante considera parte di uno stesso evento di import.