DevPortalPagoPA

SoluzioniWebinar
Tabella dei contenuti

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.

Endpoint di recupero dell'elenco dei metadati degli allegati

schema che riassume la sequenza delle operazioni coinvolte nel recupero dei dati da parte di IO.
Lo schema che riassume la sequenza delle operazioni coinvolte nel recupero dei dati da parte di IO.

Parametri

Esempio di risposta attesa

1{
2  "attachments": [
3    {
4      "id": "123456789",
5      "content_type": "application/pdf",
6      "name": "Allegato 1.pdf",
7      "url": "<percorso relativo dell'allegato>"
8    },
9    {
10      "id": "4815162342",
11      "content_type": "application/pdf",
12      "name": "Allegato 2.pdf",
13      "url": "<percorso relativo dell'allegato 2>"
14    }
15  ]
16}
17
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 richiesta GET 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 messaggio
La 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.

Endpoint di recupero dei byte del singolo allegato

chema che riassume la sequenza delle operazioni coinvolte nel recupero dei byte del singolo allegato.
Lo schema che riassume la sequenza delle operazioni coinvolte nel recupero dei byte del singolo allegato.

Parametri

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.

In questa pagina

Endpoint di recupero dell'elenco dei metadati degli allegati

Esempio di risposta attesa

Endpoint di recupero dei byte del singolo allegato

Autorizzazioni

API Key

Hai bisogno di aiuto?

Scrivi un’email in cui descrivi il tuo problema o dubbio all’indirizzo onboarding@io.italia.it

Dicci cosa ne pensi

Per segnalare problemi o dare feedback, lascia un commento nello spazio Github dell'app IO