Dopo aver creato e pubblicato un evento transazionale, è necessario integrare l'attivazione di questo evento nel sito Web.
La configurazione di un evento viene presentata in questa sezione.
Ad esempio, si desidera che venga attivato un evento "abbandono carrello" ogni volta che un cliente abbandona il sito Web prima di acquistare i prodotti nel carrello. A tal fine, lo sviluppatore Web deve utilizzare REST Transactional Messages API.
L’evento transazionale viene inviato tramite una richiesta POST con la seguente struttura URL:
POST https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>
<organization>: l’ID organizzazione personale. Fai riferimento a questa sezione.
<transactionalapi>: endPoints dell'API dei messaggi transazionali.
Il nome dell'endpoint API dei messaggi transazionali dipende dalla configurazione dell'istanza. Corrisponde al valore "mc" seguito dall’ID organizzazione personale. Prendiamo l'esempio della società Geometrixx, con "geometrixx" come ID organizzazione. In tal caso, la richiesta POST sarebbe la seguente:
POST https://mc.adobe.io/geometrixx/campaign/mcgeometrixx/<eventID>
(L'endpoint API dei messaggi transazionali è visibile anche durante l'anteprima API)
<eventid>: il tipo di evento che si desidera inviare. Questo ID viene generato durante la creazione della configurazione dell'evento (fare riferimento a questa sezione).
La richiesta deve contenere un "Content-Type: application/json" header.
È necessario aggiungere un charset, ad esempio utf-8. Questo valore dipende dall’applicazione REST in uso.
-X POST \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8' \
-H 'Content-Length:79' \
I dati dell'evento sono contenuti nel corpo del POST JSON. La struttura dell'evento dipende dalla sua definizione. Il pulsante Anteprima API nella schermata di definizione delle risorse fornisce un esempio di richiesta. Fai riferimento a questa sezione.
Al contenuto dell'evento possono essere aggiunti i seguenti parametri facoltativi per gestire l'invio di messaggi transazionali collegati all'evento:
I valori dei parametri "scadenza" e "programmata" seguono il formato ISO 8601. La norma ISO 8601 specifica l’uso della lettera maiuscola "T" per separare la data e l’ora. Tuttavia, può essere rimosso dall'ingresso o dall'uscita per una migliore leggibilità.
La risposta POST restituisce lo stato dell'evento transazionale al momento della creazione. Per recuperare il suo stato corrente (dati evento, stato evento…), utilizzate la chiave primaria restituita dalla risposta POST in una richiesta di GET:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>/
Richiesta di esempio
POST richiesta di invio dell’evento.
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/mcAdobe/EVTcartAbandonment \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8' \
-H 'Content-Length:79'
{
"email":"test@example.com",
"scheduled":"2017-12-01 08:00:00.768Z",
"expiration":"2017-12-31 08:00:00.768Z",
"ctx":
{
"cartAmount": "$ 125",
"lastProduct": "Leather motorbike jacket",
"firstName": "Jack"
}
}
Risposta alla richiesta POST.
{
"PKey":"<PKEY>",
"ctx":
{
"cartAmount": "",
"lastProduct": "",
"firstName": ""
}
"email":"",
"scheduled":"2017-12-01 08:00:00.768Z",
"expiration":"2017-12-31 08:00:00.768Z",
"href": "mcAdobe/EVTcartAbandonment/<PKEY>",
"serverUrl":" https://myserver.com ",
"status":"pending",
"type":""
}
Nella risposta, il campo "status" consente di sapere se l’evento è stato elaborato o meno: