Configurazione remota
Last updated
Last updated
Questa configurazione è necessaria se hai intenzione di utilizzare una delle seguenti funzionalità:
Per entrambe le funzionalità è infatti necessario mettere a disposizione un REST web service conforme alla relativa OpenAPI.
Un web service esposto è caratterizzato da un identificativo di configurazione, cioè un codice alfanumerico univoco, generato da IO, che corrisponderà a un set di endpoint e alle relative API key.
Devi usare la specifica chiave manage per la gestione delle configurazioni: scopri come recuperarla
Puoi definire una configurazione, richiamarla successivamente, elencare le configurazioni definite e modificarne una creata in precedenza.
Puoi anche definire più di una configurazione, nell'ambito della chiave manage in uso.
Ad esempio, se la tua Organizzazione si serve di più Partner Tecnologici che espongano ciascuno un REST web service per servire le funzionalità remote, per ciascuno di essi potrà essere definito un identificativo di configurazione differente per essere utilizzato successivamente per inviare i messaggi di propria competenza.
Per gestire le configurazioni devi utilizzare l'API descritta in CRU Configurazioni remote.
Ogni messaggio a contenuto remoto che invierai farà riferimento a una specifica configurazione: per indicarla devi utilizzare, in fase di creazione, il parametro obbligatorio .
Il servizio esposto deve essere costituito da un numero variabile di endpoint, a seconda di cosa si intenda remotizzare per i propri messaggi e del tipo di accordo che hai sottoscritto con PagoPA:
precondizioni all'apertura
titolo e corpo delle precondizioni
dettagli del messaggio
titolo e corpo del messaggio;
metadati degli allegati (solo enti Premium)
i dettagli del messaggio devono corrispondere i flag di intento dichiarati alla creazione del messaggio
byte dell'allegato
byte del singolo allegato (solo enti Premium)
Per maggiori informazioni su come progettare gli endpoint e la relativa API esposta, fai riferimento a OpenAPI endpoint di recupero dei contenuti remotizzati.
Una volta pronto, utilizza l'API descritta in CRU Configurazioni remote per registrare presso i sistemi di IO i dati necessari, tra cui:
la URL di base che servirà a IO per comporre gli indirizzi degli endpoint esposti dalla tua Organizzazione (per maggiori informazioni fai riferimento agli esempi riportati in OpenAPI endpoint di recupero dei contenuti remotizzati)
l'API key che IO userà per autenticarsi presso i tuoi sistemi e il relativo header atteso
l'eventuale preferenza di default relativa alle precondizioni all'apertura dei messaggi (per maggiori informazioni sulle precondizioni fai riferimento a Inviare un messaggio a contenuto remoto)
Allo scopo di garantire nel tempo la consistenza e il corretto funzionamento in app dei messaggi a contenuto remoto non è possibile eliminare una configurazione una volta definita.
Inoltre, per lo stesso motivo, è responsabilità del mittente adeguare tempestivamente le configurazioni ogni qualvolta si riveli necessario, utilizzando l'API di gestione descritta in CRU Configurazioni remote.