Tabella dei contenuti
Aggiungere allegati
Cosa sono gli allegati
Sono documenti in formato PDF, mostrati in calce al contenuto del messaggio. Questi allegati vengono recuperati dai sistemi dell'ente mittente ogni volta che l'utente accede alla risorsa nell'app IO.
Quando l'utente apre un messaggio vengono recuperati, oltre ai metadati del contenuto del messaggio, anche quelli relativi ai metadati (endpoint 1). Il recupero del file vero e proprio avviene tramite l'endpoint 2, ovvero con una GET all'indirizzo
Come funziona?
Step 1 - Definisci una Configurazione Remota
Per permettere a IO di conoscere i tuoi sistemi dedicati agli allegati, devi definire almeno una Configurazione Remota, che indicherai successivamente in fase di invio di ciascun messaggio.
Step 2 - Esponi gli 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.
Per maggiori informazioni, leggi le OpenAPI endpoint di recupero dei contenuti remotizzati.
Per includere gli allegati in un messaggio, oltre agli step indicati in ., devi seguire questi step:
Step 3 - Includi il blocco Third_party_data
Includi il blocco Third_party_data specificando la Configurazione remota di riferimento e l'id di correlazione remota, che IO ti restituirà quando ti chiederà i metadati e, successivamente, i byte degli allegati al particolare messaggio che stai inviando.
Step 4 - Specifica il valore TRUE nel campo Has_attachments
Step 5 - Specifica il valore ADVANCED nel campo Feature_level_type
Specifica il valore ADVANCED nel campo Feature_level_type presente nella request.
Esempi
Esempio di chiamata per l’invio di un messaggio con allegati:
1curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
2--header 'Ocp-Apim-Subscription-Key: <YOUR_API_KEY>' \
3--header 'Content-Type: application/json' \
4--data-raw '{
5 "content": {
6 "subject": "Messaggio con allegati",
7 "markdown": "# Titolo\n\nTesto del messaggio: contiene **allegati**!",
8 "third_party_data": {
9 "id": "c7832d5f-5946-48a3-ba9d-2d1e3aa3f7e5",
10 "configuration_id": "0e9852ccb8a04128bd637c807b9d80d3",
11 "has_attachments": true
12 }
13 },
14 "feature_level_type": "ADVANCED",
15 "fiscal_code": "<validFiscalCode>",
16}'
17Esempio di risposta positiva:
1{
2 "id": "01BX9NSMKVXXS5PSP2FATZMYYY"
3}
4
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