Normalmente un data feed utilizza dati presenti nelle estensioni contatto di magnews, che devono essere popolate prima dell'invio della comunicazione. Ad esempio, un sistema esterno può aggiornare periodicamente un'estensione Abbonamenti, consentendo di creare email che riepilogano gli abbonamenti attivi di ciascun destinatario. Questo approccio richiede che i dati vengano trasferiti e mantenuti sincronizzati tra il sistema esterno e magnews.
La modalità via API consente invece di recuperare i dati in tempo reale al momento della generazione della comunicazione. In questo scenario le informazioni rimangono nel sistema esterno e vengono richieste solo quando necessario, senza la necessità di importarle preventivamente in magnews. Questo approccio è particolarmente utile quando i dati sono soggetti a frequenti variazioni o quando si desidera evitare processi di sincronizzazione continuativa.
Predisponi l'end point
Predisponi un metodo API che espone dati in formato JSON.
- Il data feed è pensato per gestire collezioni di oggetti, e la struttura attesa è di tipo array.
- Le modalità di accesso sono sia in GET sia in POST.
- Gestisci l'autenticazione nell'header.
Ad esempio, un feed di ritorno per dei prodotti può avere la struttura che segue:
{
"prodotti": [
{
"image": "https://myecommerce.com/img/0.jpeg",
"marca": "Brand one",
"taglia": "U",
"costo": "149€",
"nome": "Occhiali da sole",
"sku": "SKU-1",
"disponibile": true
},
{
"image": "https://myecommerce.com/img/1.jpeg",
"marca": "Brand one",
"nome": "Scarpe da ginnastica",
"taglia": "38",
"costo": "119€",
"sku": "SKU-2",
"disponibile": false
}
],
"ok": true
}Verifica i dati esposti dal endpoint con tool come Postman.
Crea il data feed
Crea un nuovo data feed e seleziona "Chiamata API" come origine dei contenuti.
Nel tab "Chiamata API" imposta:
- URL del endpoint
- il tipo di metodo HTTP, GET o POST;
- (opzionale) header della richiesta
Fai clic su "Recupera anteprima dei dati" per effettuare una chiamata di prova, e ricevere un payload di ritorno per realizzare il mapping dei dati.
Selezione dei contenuti
Dal tab "Contenuti" seleziona il percorso dove si trovano i contenuti. Con riferimento al payload di esempio, i contenuti sono racchiusi nel percorso dei "prodotti". Seleziona la voce dalla casella a discesa, che sarà prepopolata con i dati ottenuti dalla chiamata di prova.
I campi del feed vengono popolati in automatico dalla lettura della struttura del JSON.
Conferma la selezione e salva il data feed.
Filtro
Utilizza uno dei campi mappati nel tab "Contenuti" per filtrare i dati oppure applicare un ordinamento.
Il filtro si comporta allo stesso modo dei data feed presenti su estensione contatto, selezionando una parte del contenuto ricevuto. È un filtro che si applica a valle della chiamata.
Parametri in chiamata
Ottieni dei dati di ritorno specifici del contatto a cui invii la comunicazione.
Nella sezione di "Body della richiesta" specifica parametri fissi oppure campi del contatto.
Ad esempio, utilizza la lingua del contatto per ottenere dei contenuti localizzati nella lingua del contatto.
Utilizza il data feed
Inserisci in una comunicazione email un blocco dinamico collegato al data feed.
Seleziona il feed appena creato e imposta eventualmente il numero massimo di contenuti che vorrai visualizzare.
Ad ogni invio verrà effettuata la chiamata all'end point, e mostrati i dati disponibili al momento stesso della chiamata.