Tabella dei contenuti
Panoramica dell'API
PDND Interoperabilità rende disponibile un'API REST, che permette tutte le operazioni CRUD necessarie alla gestione delle informazioni da depositare.
L'API fa parte del parco delle API di Interoperabilità, ed è possibile accedervi dopo aver ottenuto un voucher valido relativo ad un client API Interop.
Il sistema permette di gestire i tracciati solo per quanto riguarda il proprio ente. L'identificazione del chiamante da parte di PDND Interoperabilità avviene a partire dalle informazioni contenute nel voucher (token JWT) incluso nell'header della chiamata, come da pattern standard PDND.
Gestione delle informazioni
Il sistema permette agli aderenti di gestire l’invio di file CSV contenenti le informazioni relative alle transazioni avvenute. Dopo aver ricevuto il singolo file, il sistema procede con la validazione del CSV.
Qualora non siano presenti errori, il sistema elabora i dati, li arricchisce con dettagli aggiuntivi e salva i singoli record.
In caso contrario, sarà possibile verificare gli errori, e sanarli. O, in caso fosse necessario, aggiornare dati precedentemente inseriti.
Integrazione tramite OpenAPI
Il sistema è progettato per integrare servizi tramite OpenAPI.
Servizi offerti
| Metodo | Endpoint | Descrizione |
|---|---|---|
| POST | /tracings/submit | Inserimento di un tracciato per una giornata. Restituisce il tracingId di quel tracciato |
| GET | /tracings | Lista dei tracciati per l'ente richiedente |
| GET | /tracings/{tracingId}/errors | Dettaglio degli errori contenuti in un singolo tracciato |
| POST | /tracings/{tracingId}/recover | Sanificazione delle informazioni in un tracciato che presenta errori o dati mancanti |
| POST | /tracings/{tracingId}/replace | Sostituzione integrale dei dati di un tracciato precedentemente caricato |
Specifica OpenAPI
La specifica OpenAPI dell'API di tracing è disponibile al seguente indirizzo.
Hai bisogno di aiuto?
Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata
