LogoLogo
v5.0
v5.0
  • 🏠Guida tecnica
  • 🕗Changelog
  • 🔢Setup iniziale
    • Adesione tramite l'Area Riservata
    • Iscrizione al Developer Portal
    • Condivisione configurazione remota
  • Funzionalità
    • 📦Pubblicare un servizio
      • Creare un servizio
      • Provare un servizio in test
      • Revisione del servizio
      • Visibilità del servizio
      • Importare servizi nell'Area Riservata
      • Dati obbligatori
        • Attributi
        • Service Metadata
      • Informazioni sensibili
      • Argomento del servizio
      • Stato del servizio
      • Chiave manage
    • ✉️Inviare un messaggio
      • Messaggi di test
      • Inviare un messaggio tradizionale
      • Inviare un messaggio a contenuto remoto
      • Aggiungere allegati
  • API e specifiche
    • 📐OpenAPI
    • API Servizi
      • Manage Service: Get
      • Manage Service: Get keys
      • Manage Service: Get User Services
      • Manage Service: Create
      • Manage Service: Delete
      • Manage Service: Update
      • Manage Service: Request Review
      • Manage Service: Release
      • Manage Service: Get Released
      • Manage Service: Unpublish
      • Manage Service: Regenerate api key
      • Manage Service: Upload service logo
      • Upload organization logo
      • Service Topics: Get all service topics
    • API Messaggi
      • Get a User Profile using POST
      • Submit a Message passing the user fiscal_code in the request body
      • Get Message
      • Get Subscriptions Feed
      • ⚠️Get a User Profile
      • ⚠️Submit a Message passing the user fiscal_code as path parameter
    • Errori comuni
    • Specifiche API
    • OpenAPI endpoint di recupero dei contenuti remotizzati
  • 🔑Abilitazioni
    • Test con Codici Fiscali reali
    • Test invio avvisi pagoPA
    • Invio messaggi massivo
    • Subscription feed
    • Gestione dei servizi
    • Funzionalità Premium
  • Risorse Utili
    • ❓Supporto agli Enti (tutorial, FAQ)
    • 📘Glossario
Powered by GitBook
On this page
  • Cosa sono gli allegati
  • Come funziona?
  • Esempi
  1. Funzionalità
  2. ✉️Inviare un messaggio

Aggiungere allegati

PreviousInviare un messaggio a contenuto remotoNextOpenAPI

Questa funzionalità è riservata agli enti che hanno sottoscritto il programma Premium.

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.

Per garantire l'accessibilità e la sicurezza dei documenti, devi utilizzare allegati in formato PDF/A-2a: assicurati di rispettare tale specifica.

Come funziona?

Step 0 - 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 Inviare un messaggio, devi seguire questi step:

Esempi

Esempio di chiamata per l’invio di un messaggio con allegati:

curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
--header 'Ocp-Apim-Subscription-Key: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "content": {
    "subject": "Messaggio con allegati",
    "markdown": "# Titolo\n\nTesto del messaggio: contiene **allegati**!",
    "third_party_data": {
      "id": "c7832d5f-5946-48a3-ba9d-2d1e3aa3f7e5", 
      "has_attachments": true
    }
  },
  "feature_level_type": "ADVANCED",
  "fiscal_code": "<validFiscalCode>",
}'

Esempio di risposta positiva:

{
  "id": "01BX9NSMKVXXS5PSP2FATZMYYY"
}
Step 1 - Includi il blocco
Step 2 - Specifica il valore TRUE nel campo
Step 3 - Specifica il valore ADVANCED nel campo

Nota che non stai effettivamente inviando gli allegati al momento della creazione del messaggio: lo farai successivamente, quando il destinatario vorrà visualizzarli in app e IO invocherà allo scopo

Includi il blocco specificando 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.

Specifica il valore TRUE nel campo presente nel blocco .

Specifica il valore ADVANCED nel campo presente nella request.

l'API da te esposta
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 {baseUrl}/messages/{id}/{url}
third_party_data
third_party_data
has_attachments
has_attachments
third_party_data
feature_level_type
feature_level_type
Esempio di come un utente può visualizzare un messaggio che contiene un allegato.