Trabajo con integraciones estándar external-sources

En esta página: Obtenga información sobre cómo los administradores configuran, prueban y activan integraciones externas que conectan Adobe Journey Optimizer con API de terceros, de modo que los especialistas en marketing puedan utilizarlas para crear contenido dinámico y personalizado en canales salientes.

AVAILABILITY
Esta función de integración está restringida a canales salientes (correo electrónico, SMS y push) y admite la extracción de JSON o HTML.

Una integración de Standard conecta Journey Optimizer directamente con una API de terceros para que puedas extraer datos o contenido externos en tus canales salientes y personalizarlos.

También puede vincular una integración de navegación al parámetro de una integración estándar para que el valor que seleccionen los especialistas en marketing se pase automáticamente a la llamada de la API.

Creación de integraciones estándar configure

Como administrador, puede configurar integraciones externas siguiendo estos pasos:

Configuración de la integración y la solicitud

Comience creando la integración y definiendo cómo llama a la API externa.

  1. Vaya a la sección Configuraciones del menú de la izquierda y haga clic en Administrar desde la tarjeta Integraciones.

    A continuación, haga clic en Crear integración para iniciar una nueva configuración.

    Tarjeta de integraciones con el botón Crear integración en la sección Configuraciones {modal="regular"}

  2. Opcionalmente, pegue un comando cURL para rellenar automáticamente la dirección URL, el método HTTP, los encabezados y los parámetros de consulta.

  3. Proporcione un Nombre y una Descripción para su integración.

    note
    NOTE
    El campo Nombre no puede contener espacios.
  4. Escriba el extremo de API URL.

    Para las variables de ruta de acceso, ajuste una etiqueta entre llaves dobles en la dirección URL, por ejemplo, https://api.example.com/v1/products/{{productId}}, y después establezca cada marcador de posición en Parámetro de ruta de acceso.

  5. Seleccione Habilitar exploración para vincular una integración de exploración activa, de modo que sus campos de respuesta se puedan asignar a variables en encabezados, parámetros de consulta y ruta de acceso y la carga útil.

    ➡️ Ver Crear integraciones de exploración

    Habilitar la opción de exploración que vincula una integración de exploración con un parámetro de integración estándar {modal="regular"}

  6. Configure el Parámetro de ruta de acceso con Nombre y Valor predeterminado para cada marcador de posición que agregó en la dirección URL.

    Tenga en cuenta que Name es una etiqueta orientada al especialista en marketing solo en el editor; no se envía en la solicitud de API.

    Configuración del parámetro de ruta de acceso con campos Nombre y Valor predeterminado para cada marcador de posición {modal="regular"}

  7. Seleccione el método HTTP entre GET y POST.

  8. Haga clic en Agregar encabezado o en Agregar parámetros de consulta según sea necesario para la integración. Proporcione los siguientes detalles para cada parámetro:

    • Parámetro: El nombre real del encabezado o del parámetro de consulta que espera la API.

    • Name: una etiqueta compatible con el especialista en marketing para este parámetro, los autores la seleccionan al asignar valores en las campañas.

    • Tipo: elige Constante para un valor fijo o Variable para entrada dinámica.

    • Valor: escriba el valor directamente para las constantes o seleccione una asignación de variables.

    • Obligatorio: especifique si este parámetro es necesario. Para los parámetros Variable obligatorios, si no se resuelve ningún valor en tiempo de ejecución y no se proporciona ningún valor predeterminado, la generación de solicitudes falla con un error y no se realiza la llamada de API saliente.

    Configuración de parámetro de consulta y encabezado con los campos Parámetro, Nombre, Tipo, Valor y Obligatorio {modal="regular"}

Con la solicitud definida, está listo para configurar la autenticación, la directiva y la carga útil de respuesta.

Configurar autenticación, directiva y respuesta

Después de definir la solicitud, configure cómo se autentica y comporta y dé forma a la respuesta utilizada para la personalización.

  1. Elija un tipo de autenticación:

    • Sin autenticación: Para las API abiertas que no requieren credenciales.

    • clave de API: autentique solicitudes con una clave de API estática. Escriba su Nombre de clave API, Valor de clave API y especifique su ubicación.

    • Autenticación básica: use la autenticación básica estándar de HTTP. Escriba Nombre de usuario y Contraseña.

    • OAuth 2.0: realice la autenticación mediante el protocolo OAuth 2.0. Haga clic en el icono editar para configurar o actualizar la carga útil.

    Opciones de tipo de autenticación que incluyen Sin autenticación, clave de API, Autenticación básica y OAuth 2.0 {modal="regular"}

  2. Establezca la configuración de directiva, como el período de tiempo de espera para las solicitudes de API, y elija habilitar la restricción, la caché o reintentar.

    note
    NOTE
    Con la restricción habilitada, las tasas admitidas son de 50 a 5000 TPS. Los límites se aplican a la integración, no a cada extremo de API.
    Con el reintento habilitado, otros errores se reintentarán tres veces de forma predeterminada, con 200 ms, 400 ms y 800 ms entre intentos.
  3. Para un método POST, configure la carga útil eligiendo un tipo de cuerpo:

    • JSON: Haga clic en el icono editar y pegue la carga de la solicitud JSON. Asigne las variables que necesita cumplir en la carga útil.

    • GraphQL: pegue la consulta de GraphQL. Journey Optimizer genera un nombre de operación automáticamente y le permite asignar las variables de consulta correspondientes.

      Carga útil de GraphQL con nombre de operación generado y asignación de variable de consulta {modal="regular"}

  4. Elija Tipo de respuesta entre JSON y HTML.

  5. Con el campo Carga de respuesta, puede decidir qué campos de la salida de ejemplo se deben utilizar para la personalización de mensajes.

    Haga clic en el icono edit y pegue una carga útil de respuesta JSON de muestra para detectar automáticamente los tipos de datos.

  6. Elija los campos que desea exponer para la personalización y especifique sus tipos de datos correspondientes.

    Campos de carga de respuesta seleccionados para la personalización con tipos de datos detectados {modal="regular"}

    note
    NOTE
    La configuración Carga de respuesta define la respuesta esperada para la creación, incluido cualquier esquema aplicado en ese paso. Los especialistas en marketing solo pueden hacer referencia a campos expuestos, los tokens de otras rutas no superan la validación en el editor.

Una vez configuradas la autenticación, la directiva y la respuesta, pruebe la conexión antes de activarla.

Prueba de la conexión connection

Enviar conexión de prueba valida la dirección URL del extremo, la autenticación y la estructura de solicitudes con la API de destino antes de la activación, lo que reduce el riesgo de errores de tiempo de ejecución durante el procesamiento de mensajes.

  1. Cuando se definan la dirección URL, el método HTTP, los encabezados y los parámetros de consulta, haga clic en Enviar conexión de prueba para ejecutar una prueba de conectividad y confirmar la configuración.

  2. En el cuadro de diálogo Enviar conexión de prueba, escriba valores predeterminados para cualquier marcador de posición de Variable en la ruta de acceso de la dirección URL, los encabezados y los parámetros de consulta.

    Estos valores se incluyen en la solicitud de prueba. Journey Optimizer invoca el extremo e informa de si la conexión se realizó correctamente o no.

    Enviar cuadro de diálogo de conexión de prueba con valores predeterminados para marcadores de posición de variables {modal="regular"}

  3. Si la prueba devuelve una respuesta correcta, seleccione Usar como carga útil de respuesta para copiar el cuerpo de respuesta en el campo Carga útil de respuesta; consulte el paso 10 en Configurar la integración, donde se pueden detectar tipos de datos y se pueden seleccionar campos para la personalización.

    Respuesta de conexión de prueba correcta con la opción Usar como carga de respuesta {modal="regular"}

  4. Si la prueba no se realiza correctamente, expanda la lista desplegable Error para revisar los detalles del error, actualice la configuración de la integración según sea necesario y ejecute Enviar conexión de prueba de nuevo.

    Detalles del error de conexión de prueba mostrados en la lista desplegable de errores {modal="regular"}

Una vez que la prueba se haya realizado correctamente, seleccione Activar en la configuración de la integración.

Administrar las integraciones

Después de una prueba correcta, active la integración y, a continuación, actualícela o archívela según sea necesario.

  1. Una vez validado, haga clic en Activar.

  2. Acceda a la integración recién creada para:

    • Actualización: cambia los detalles de Autenticación y la configuración de directiva solamente. Las actualizaciones se aplican a recorridos en directo y campañas. Antes de guardar los cambios, usa el menú Explorar referencias para confirmar dónde se usa la integración.

    • Archivo: Archive una configuración de integración.

      Opciones de actualización y archivado para una configuración de integración {modal="regular"}

  3. Después de la activación, haz clic en el icono menú avanzado para acceder al menú Explorar referencias y revisar el uso de esta configuración, incluidos los recorridos y las campañas que dependen de ella.

    Explorar el menú de referencias que muestra recorridos y campañas que utilizan la integración {modal="regular"}

Una vez que la integración esté activa, tenga en cuenta el siguiente comportamiento del tiempo de envío.

Límites y comportamiento del tiempo de envío configure-send-time

En el momento del envío, las respuestas de la API externa pueden ser de hasta 4 MB de forma predeterminada. Cualquier elemento de mayor tamaño se trata como un error de integración y no se intentan reintentos cuando el error se debe al tamaño de la respuesta.

Las llamadas respetan la tasa de regulación throttling que configuró: las programaciones de Journey Optimizer intentan alcanzar ese límite incluso cuando el sistema externo está inactivo o devuelve errores. Si cache está habilitado, solo se almacenan y reutilizan las respuestas correctas hasta que la caché TTL que definió caduque; las respuestas con errores nunca se almacenan en caché.

Cada mensaje en cola también lleva un período de validez (TTL). Si el procesamiento se retrasa y un mensaje pasa por esa ventana, el sistema lo descarta y emite un evento MessageValidityExclusion, de modo que el trabajo obsoleto se borra de la cola y los recursos permanecen disponibles.

Consulte también

recommendation-more-help
journey-optimizer-help