Administración de mensajes transaccionales

Última actualización: 2023-12-29
  • Temas:
  • API
    Ver más sobre este tema
  • Creado para:
  • Experienced
    Developer

Una vez creado y publicado un evento transaccional, debe integrar la activación de este evento en el sitio web.

NOTA

La configuración de eventos se detalla en esta sección.

Por ejemplo, desea que se active un evento "Abandono del carro de compras" cada vez que uno de los clientes abandone el sitio web antes de comprar los productos que tiene en el carro de compras. Para ello, como desarrollador web, debe utilizar la API de mensajes transaccionales de REST.

  1. Envíe una solicitud según el método POST, que almacena en déclencheur la variable envío del evento transaccional.
  2. La respuesta a la solicitud del POST contiene una clave principal, que le permite enviar una o varias solicitudes a través de una solicitud de GET. A continuación, puede obtener la estado del evento.

Envío de un evento transaccional

El evento transaccional se envía a través de una solicitud de POST con la siguiente estructura de URL:

POST https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>
  • <organization>: su ID de ORGANIZACIÓN personal. Consulte esta sección.

  • <transactionalapi>: los puntos finales de la API de mensajes transaccionales.

    El nombre del punto de conexión de la API de mensajes transaccionales depende de la configuración de la instancia. Corresponde al valor "mc" seguido de su ID personal de organización. Veamos el ejemplo de la empresa de Geometrixx, con "geometrixx" como ID de organización. En ese caso, la solicitud del POST sería la siguiente:

    POST https://mc.adobe.io/geometrixx/campaign/mcgeometrixx/<eventID>

    Tenga en cuenta que el extremo de la API de mensajes transaccionales también está visible durante la vista previa de la API.

  • <eventid>: el tipo de evento que desea enviar. Este ID se genera al crear la configuración de evento (consulte esta sección).

encabezado de solicitud de POST

La solicitud debe contener un encabezado "Content-Type: application/json".

Debe añadir un conjunto de caracteres, por ejemplo utf-8. Tenga en cuenta que este valor depende de la aplicación REST que utilice.

-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' \

cuerpo de solicitud del POST

Los datos de evento están contenidos dentro del cuerpo del POST JSON. La estructura del evento depende de su definición. El botón Vista previa de API en la pantalla de definición del recurso proporciona un ejemplo de solicitud. Consulte esta sección.

Se pueden añadir los siguientes parámetros opcionales al contenido del evento para administrar el envío de mensajes transaccionales vinculados al evento:

  • vencimiento (opcional): después de esta fecha, se cancela el envío del evento transaccional.
  • programado (opcional): a partir de esta fecha, se procesa el evento transaccional y se envía el mensaje transaccional.
NOTA

Los valores de los parámetros "caducidad" y "programada" siguen el formato ISO 8601. ISO 8601 especifica el uso de la letra mayúscula "T" para separar la fecha y la hora. Sin embargo, se puede eliminar de la entrada o salida para mejorar la legibilidad.

Respuesta a la solicitud del POST

La respuesta del POST devuelve el estado del evento transaccional en el momento en que se creó. Para recuperar su estado actual (datos de evento, estado de evento…), utilice la clave principal devuelta por la respuesta del POST en una solicitud de GET:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>/


Solicitud de ejemplo

Solicitud del POST para enviar el 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"
  }
}

Respuesta a la solicitud del 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":""
}

Estado del evento transaccional

En la respuesta, el campo "estado" permite saber si el evento se ha procesado o no:

  • pendiente: el evento está pendiente: el evento adquiere este estado cuando acaba de activarse.
  • procesamiento: el evento está pendiente de envío: se está transformando en un mensaje y el mensaje se está enviando.
  • pausado: el proceso de eventos se está pausando. Ya no se procesa, sino que se mantiene en cola en la base de datos de Adobe Campaign. Para obtener más información, consulte esta sección.
  • Procesado: el evento se procesó y el mensaje se envió correctamente.
  • ignorado: el envío ignoró el evento, normalmente cuando una dirección está en cuarentena.
  • deliveryFailed: error de envío mientras se procesaba el evento.
  • routingFailed: la fase de enrutamiento ha fallado; esto puede ocurrir, por ejemplo, cuando no se encuentra el tipo de evento especificado.
  • toOld: el evento caducó antes de que se pudiera procesar. Esto puede ocurrir por varios motivos, por ejemplo, cuando un envío falla varias veces (esto hace que el evento ya no esté actualizado) o cuando el servidor ya no puede procesar eventos después de sobrecargarse.
  • targetingFailed: el Campaign Standard no ha podido enriquecer un vínculo que se está utilizando para la segmentación de mensajes.

En esta página