Specifiche degli endpoint di recupero degli allegati
Last updated
v2.4
Last updated
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 .
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.
Il campo
content_typedeve contenere il valore "application/pdf" in quanto IO accetta unicamente allegati in formato PDF conformi allo standard PDF/A.Il campo
urldeve contenere il percorso relativo per il download dell’allegato. Questo perché IO scarica gli allegati tramite una richiestaGETall'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
namedeve 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.
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.
L'identificativo {id} che riceverai in questa chiamata corrisponderà a quello che avevi specificato nel blocco in fase di invio del messaggio.
Returns the Third Party message with the provided message ID. User's fiscal code is required as header parameter.
ID of the Third Party message.
The fiscal code of the user, all upper case.
[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]The method of the endpoint called by IO app
The url of the endpoint called by IO app
^https://The signature input, needed to verify the signature header
^(?:sig\d+=[^,]*)(?:,\s*(?:sig\d+=[^,]*))*$The signature of the HTTP request, signed by the client with its private key.
^((sig[0-9]+)=:[A-Za-z0-9+/=]*:(, ?)?)+$^(sha256-[A-Za-z0-9-_=]{1,44})$^(sha384-[A-Za-z0-9-_=]{1,66})$^(sha512-[A-Za-z0-9-_=]{1,88})$represents a Base64url encode of a JWK Public Key
The user's fiscal code, all upper case.
^[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]$Returns the Third Party message with the provided message ID. User's fiscal code is required as header parameter.
ID of the Third Party message.
The fiscal code of the user, all upper case.
[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]The method of the endpoint called by IO app
The url of the endpoint called by IO app
^https://The signature input, needed to verify the signature header
^(?:sig\d+=[^,]*)(?:,\s*(?:sig\d+=[^,]*))*$The signature of the HTTP request, signed by the client with its private key.
^((sig[0-9]+)=:[A-Za-z0-9+/=]*:(, ?)?)+$^(sha256-[A-Za-z0-9-_=]{1,44})$^(sha384-[A-Za-z0-9-_=]{1,66})$^(sha512-[A-Za-z0-9-_=]{1,88})$represents a Base64url encode of a JWK Public Key
The user's fiscal code, all upper case.
^[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]$
