CRU Configurazioni remote
Descrizione
Questa API consente alla tua Organizzazione di registrarsi presso IO come provider di contenuti remoti e di gestire nel tempo la registrazione.
La registrazione ha come oggetto le configurazioni, ossia l'insieme delle informazioni utili a creare la comunicazione tra IO e le infrastrutture della tua Organizzazione, secondo il protocollo definito nel paragrafo messaggi a contenuto remoto.
Per maggiori informazioni puoi consultare la pagina dedicata nella sezione Setup iniziale
Tutte le API descritte in questa pagina si riferiscono alle attività dell'Ente tramite Area Riservata e si basano sull'ottenimento e l'utilizzo della chiave "manage" che puoi recuperare nell'area di gestione dei Servizi di IO.
Le operazioni a disposizione comprendono:
La creazione di una nuova configurazione remota
La modifica di una configurazione remota esistente
Il recupero delle configurazioni remote definite
Il recupero di una particolare configurazione definita
La cancellazione di una configurazione remota non è al momento supportata
Fai riferimento al paragrafo Esempi per maggiori informazioni sull'utilizzo dei campi e sugli scenari d'uso censiti.
API "Create"
Con questa API puoi creare una nuova configurazione per ottenere il configuration_id
da utilizzare in tutte le chiamate successive, anche per la creazione dei messaggi a contenuto remoto.
API "Update"
Questa API ti consente di aggiornare una configurazione esistente, identificata dal configuration_id
.
Allo scopo di garantire nel tempo la consistenza e il corretto funzionamento in app dei messaggi a contenuto remoto, è onere del mittente adeguare tempestivamente le configurazioni ogni qualvolta si riveli necessario, utilizzando l'API di gestione qui descritta.
API di recupero delle configurazioni definite
Con questa API puoi recuperare le configurazioni definite nell'ambito della sottoscrizione indicata negli header. Ciascun elemento ritornato nell'array rcConfigList
riporta il nome, la descrizione, la presenza di precondizioni e i dati tecnici propri della configurazione (URL di base e informazioni di autenticazione).
API di recupero di una configurazione
Con questa API, utilizzando come chiave il configuration_id
, puoi recuperare i dati specifici della corrispondente configurazione.
Esempi
Creazione di una configurazione remota
Nell'esempio riportato, si richiede la creazione di una nuova configurazione relativa al solo ambiente di produzione, per il quale sono indicati:
la URL di base nel campo
base_url
("https://theremotecontentdomain.tld/basepath")la relativa API key con cui si autenticherà su IO (
"ac66427c-584b-4c81-9443-e761a226d33d"
, nel campokey
, valore che i tuoi sistemi si attenderanno nell'header con nome"X-API-KEY"
indicato nel campoheader_key_name
)
Il campo has_precondition
regola l'interpretazione, da parte di IO, del corrispondente campo has_precondition che indicherai in fase di creazione di un messaggio a contenuto remoto, secondo il seguente schema:
[non specificato] | Le precondizioni all'apertura del messaggio saranno mostrate coerentemente con l'impostazione di |
| Se il campo |
| Se il campo |
| Se il campo |
Ricorda di impostare sempre il valore del campo details_authentication.type
con la costante "API-KEY"
In risposta otterrai, nel campo "configuration_id"
, l'identificativo della configurazione che dovrai usare in tutte le chiamate seguenti, comprese quelle di creazione dei messaggi a contenuto remoto che dovranno essere serviti da essa.
Creazione di configurazioni remote distinte per test e produzione
In questo secondo esempio, puoi vedere come creare una configurazione relativa agli ambienti di test e produzione.
I due blocchi "prod_environment"
e "test_environment"
sono utilizzati da IO per contattare la tua infrastruttura secondo il seguente schema:
indichi solo | IO ti contatterà usando sempre quella configurazione |
indichi solo | IO ti contatterà usando sempre quella configurazione |
indichi sia | IO ti contatterà usando la configurazione indicata in |
Nel selezionare i destinatari da indicare in "test_users"
ricorda che non è consentito l'invio di messaggi di test all'utenza generale: assicurati di avere il consenso degli interessati e che questi siano a conoscenza del test in corso.
In risposta otterrai, nel campo "configuration_id"
, l'identificativo della configurazione che dovrai usare in tutte le chiamate seguenti, comprese quelle di creazione dei messaggi a contenuto remoto che dovranno essere serviti da essa.
Recupero delle configurazioni definite
In questo esempio ti mostriamo come recuperare l'elenco completo delle configurazioni che hai definito nell'ambito della tua sottoscrizione:
Recupero di una specifica configurazione
In questo esempio puoi vedere come, essendo in possesso di un configuration_id
, puoi recuperare tutte le informazioni relative a una configurazione definita in precedenza:
Modifica di una configurazione esistente
In questo esempio ti mostriamo come puoi aggiornare i dati di una configurazione definita in precedenza, nello specifico qui si modifica la sua descrizione:
Allo scopo di garantire nel tempo la consistenza e il corretto funzionamento in app dei messaggi a contenuto remoto, è responsabilità del mittente adeguare tempestivamente le configurazioni ogni qualvolta si riveli necessario, utilizzando l'API di gestione qui descritta.
Risorse utili
https://developer.io.italia.it/openapi.html#tag/remote-content
Last updated