Controllo pre-invio

A cosa serve il controllo pre-invio?

Prima di inviare un messaggio ad un cittadino è necessario effettuare i seguenti controlli:

• il cittadino è iscritto ad IO;

• il cittadino non ha disattivato le comunicazioni del servizio (di default i cittadini sono iscritti a tutti i servizi, ma è possibile che un cittadino abbia disattivato le comunicazioni da un servizio).

Gli utenti di IO possono decidere se usare una configurazione rapida dei servizi (ed essere iscritti di default a tutti i servizi presenti e futuri) oppure una configurazione manuale, che prevede un'attivazione a uno a uno di tutti i servizi.

Come si effettua?

Il controllo pre-invio può essere effettuato in due modalità.

API Get a User Profile

È possibile utilizzare l’API Get a User Profile using POST per ogni codice fiscale a cui si vuole inviare un messaggio e controllare i valori della risposta. La risposta è ritenuta positiva se entrambe le condizioni sono verificate:

• lo status code della risposta è 200

• nel body di risposta il campo sender_allowed=true

Il metodo Get a User Profile è deprecato. Ti consigliamo di non usarla ed eventualmente di sostituirla con Get a User Profile using POST

API Get Subscriptions Feed

Questa modalità è riservata agli enti centrali o di livello nazionale.

L'API Get Subscriptions Feed permette di effettuare il download degli hash dei codici fiscali dei cittadini iscritti/disiscritti ad un servizio in un determinato giorno.

Lo scopo del subscription feed è mettere a disposizione degli enti centrali (es.: ministeri, enti di livello nazionale, ecc) uno strumento per minimizzare le chiamate verso l'infrastruttura di IO attraverso un filtro costruito dall’ente stesso.

Le informazioni del subscription feed sono aggiornate al giorno precedente. Per la costruzione del subscription feed è necessario interrogare il servizio per ogni giorno a partire dalla data del 24/03/2020 fino alla data attuale.

Esempi

Esempio d’uso con la versione POST di Get a User Profile using POST:

### REQUEST
curl --location --request POST 'https://api.io.pagopa.it/api/v1/profiles' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
--header 'Content-Type: application/json' \
--data-raw '{
"fiscal_code": "AAAAAA00A00A000A"
}'

risposta corretta con status 200:

### RESPONSE
{
"sender_allowed": true
}