Specifiche degli endpoint di recupero degli allegati
Per permettere a IO di recuperare il contenuto di un messaggio e dei suoi allegati, devi mettere a disposizione un REST web service conforme alla relativa OpenAPI.
Il servizio deve esporre due endpoint, che il backend di IO richiamerà quando necessario.
Una volta pronti, comunica al team di IO gli endpoint (baseUrl) e la relativa API Key.
Per comunicare col team di IO puoi usare l'indirizzo email onboarding@io.italia.it
Endpoint di recupero dell'elenco dei metadati degli allegati
Esempio di risposta attesa
Il campo
content_type
deve contenere il valore "application/pdf
" in quanto IO accetta unicamente allegati in formato PDF conformi allo standard PDF/A.Il campo
url
deve contenere il percorso relativo per il download dell’allegato. Questo perché IO scarica gli allegati tramite una richiestaGET
all'indirizzo{baseUrl}/messages/{id}/{url}
, dove:
baseUrl
è l'endpoint che hai comunicato al team di IO in fase di onboarding
id
è l'identificativo che avevi specificato nel blocco in fase di invio del messaggioLa composizione delle varie parti costituisce la URL completa di download del singolo allegato nell'ambito del servizio REST che esponi, come illustrato nel capitolo seguente.
Il campo
name
deve contenere il nome dell'allegato così come comparirà nel messaggio, all'interno della sezione "Allegati": sceglilo con cura in modo da comunicare correttamente con il tuo destinatario.
Aggiungi sempre l'estensione .pdf
nei campi name
per consentire al sistema operativo di destinazione una corretta gestione del file eventualmente scaricato sul dispositivo.
Endpoint di recupero dei byte del singolo allegato
Autorizzazioni
API Key
IO garantisce che il codice fiscale nella request corrisponda a quello dell'utente che sta provando a recuperare gli allegati. Il codice fiscale viene inviato attraverso l'header fiscal_code
.
L'ente deve verificare che il Codice Fiscale dell’utente sia autorizzato ad accedere al dato richiesto.
In futuro, verranno aggiunti ulteriori metodi di autenticazione (Bearer Token, OAuth Token etc.)
Last updated