Configuración de acciones externas

Las acciones externas permiten que los recorridos de cuenta de Journey Optimizer B2B edition se conecten con sistemas externos directamente desde el lienzo de recorrido. Cuando una audiencia de cuenta llega a un nodo de acción externa, el sistema realiza una llamada saliente asincrónica a un servicio externo configurado y pasa los datos de atributos de audiencia para cuentas, personas o ambos. El servicio externo procesa los datos y responde con una llamada de retorno, devolviendo datos de audiencia y metadatos que se pueden utilizar como guía para la ejecución del recorrido.

Esta función admite dos tipos de nodos de recorrido:

  • Acción externa: llama a un servicio externo y continúa en una sola ruta de salida. Ideal para activar y olvidar integraciones, como actualizar un registro CRM o activar una notificación descendente.
  • Rutas divididas externas: llama a un servicio externo y evalúa la respuesta para enrutar cuentas a lo largo de una de varias rutas definidas.
NOTE
Los servicios de acción externa solo se admiten para recorridos de cuenta. Estos tipos de nodo no están disponibles para los recorridos de persona.

Resumen de implementación

La configuración de acciones externas requiere una coordinación entre tres funciones en secuencia:

Implementación del servicio externo implement-service

El desarrollador debe crear y publicar un servicio web público que cumpla con la Interfaz de proveedor de servicios de acciones externas de Adobe Journey Optimizer B2B edition.

NOTE
La función de devolución de llamada requiere un token de portador. Recupere esto configurando credenciales de servidor a servidor OAuth en Adobe Developer Console para su organización IMS.

Una vez que el servicio esté activo, proporcione la URL de la especificación OpenAPI y las credenciales de autenticación al administrador del producto responsable de configurar la acción.

Configurar la acción configure-action

Se debe configurar y activar una acción antes de que los especialistas en marketing puedan utilizarla en un recorrido. Las acciones se crean en estado Borrador y los cambios se guardan automáticamente. Permanece como borrador hasta que lo activa.

PREREQUISITES
Obtenga la URL de la especificación OpenAPI y las credenciales de autenticación del desarrollador antes de añadir la configuración.
Para definir y activar una acción externa, debe tener el permiso de administración de configuraciones de B2B producto.
  1. Vaya a Administración > Configuraciones.

  2. Haga clic en Acciones externas en el panel intermedio.

    Acceder al espacio de configuración de acciones externas {width="800" modal="regular"}

  3. Haga clic en Crear acción en la parte superior derecha.

  4. Escriba la dirección URL de la especificación OpenAPI para el servicio externo y haga clic en Crear.

    Escriba la dirección URL del servicio {width="500"}

    El servicio externo debe estar activo y accesible para que este paso se realice correctamente. Si hay un error de validación, el cuadro de diálogo muestra un mensaje para describir el error y una sugerencia para resolverlo. Para obtener más información, consulte Solución de problemas.

  5. Cuando la dirección URL se resuelva correctamente, revise Detalles del servicio.

    Los detalles del servicio se leen directamente desde la especificación OpenAPI cuando se crea la acción. Estas propiedades no se pueden cambiar en la configuración después de la creación.

    table 0-row-3 1-row-3 2-row-3 3-row-3
    Propiedad Descripción Propiedad de especificación OpenAPI
    Nombre Nombre de la acción info.title
    Descripción Descripción de la acción info.description
    Dirección URL URL de la especificación OpenAPI que define el servicio externo servers.url
  6. Escriba las credenciales de Authentication para el servicio externo (components.securitySchemes).

    note
    NOTE
    Los campos de credenciales mostrados dependen del mecanismo de autenticación definido en el servicio externo. Los tipos compatibles son Clave de API, OAuth2 y Autenticación básica HTTP.

    Agregar las credenciales de autenticación {width="600" modal="regular"}

    Puede cambiar las credenciales según sea necesario cuando la acción configurada esté en estado Borrador o Activo.

  7. Haga clic en Next.

  8. Establezca las propiedades Configurations para definir cómo la acción intercambia datos con el servicio externo.

    note
    NOTE
    Las propiedades marcadas como Estáticas no se pueden actualizar en el momento de la configuración y se basan en la definición del servicio.
    • Tipo de acción (Estática): el tipo de nodo de recorrido admitido:

      • Acción externa (enableSplitPath = false)
      • Ruta dividida de acción externa (enableSplitPath = true)

      No se puede cambiar el tipo de acción después de crear la configuración de acción.

    • Descriptores de acceso (Estáticos) - (Solo ruta de acceso dividida de acción externa) Las variables devueltas por el servicio externo para que estén disponibles como condiciones de ruta de acceso en un nodo de ruta de acceso dividida externa. (invocationPayloadDef.accessorsMetadata)

    • Contexto de Recorrido (Estático): el ámbito de los datos de audiencia enviados en la solicitud (supportedEntityType):

      • Cuenta - Envía solamente cuentas

      • Personas: envía solamente personas

      • Personas en la cuenta: envía cuentas y personas relacionadas con la cuenta

    • Campos de salida: asigne cada campo de la tabla a un campo XDM. Estos campos se envían en el cuerpo de la solicitud al servicio externo. Propiedades de definición de servicio: invocationPayloadDef.accountFields, invocationPayloadDef.fields.

      Asignar campos de salida de acción externa {width="600" modal="regular"}

    • Campos entrantes: asigne cada campo de la tabla a un campo XDM actualizable. Estos campos se rellenan desde la respuesta del servicio externo. Propiedades de definición de servicio: callbackPayloadDef.accountFields, callbackPayloadDef.fields. Actualizable después de la creación.

    • Parámetros de encabezado: escriba un valor para cada fila para pasarla como un encabezado HTTP en la solicitud. Propiedad de definición de servicio: invocationPayloadDef.headers.

    • Tiempo de espera: escriba el número de minutos que esperar para que el servicio externo invoque la devolución de llamada antes de que la solicitud se considere errónea. Propiedad de definición de servicio: timeout.

    • Atributos globales: escriba un valor para cada fila para incluirlo como campo estático en el cuerpo de la solicitud. Propiedad de definición de servicio: invocationPayloadDef.globalAttributes.

      Parámetros, tiempo de espera y atributos globales del encabezado de acción externa {width="600" modal="regular"}

  9. Haga clic en la flecha hacia atrás para regresar a la lista y mantener la acción en estado Borrador.

    O haga clic en Activar para cambiar la configuración de la acción al estado Activo. La acción externa configurada debe estar activa para que esté disponible para su uso en recorridos de cuenta.

Resolución de problemas troubleshooting

Cuando introduce la URL de la especificación OpenAPI para el servicio externo y hace clic en Crear, el sistema valida el servicio. Cuando encuentra un error, el cuadro de diálogo muestra un mensaje para describirlo.

Mensaje de error de validación del servicio de URL de acción externa {width="600" modal="regular"}

NOTE
Muchos de los siguientes errores requieren que trabaje con el desarrollador que creó y publicó el servicio web público para resolverlos.

Detalles del error de validación

Error mostrado
Por qué sucedió
Qué hacer
This URL is already used by another external action
Esta URL de especificación ya está registrada en una acción diferente de su organización.
Utilice una URL de especificación diferente o elimine la acción existente que ya la utiliza.
An action with this name already exists
El info.title de su especificación coincide con una acción que ya existe
Cambie el título del campo info.title de su especificación por algo único.
Duplicate operation ID found in the specification
Dos o más operaciones de su especificación comparten el mismo(a) operationId.
Asigne a cada operación un operationId único.
Field in the specification exceeds the maximum allowed length
Un campo de texto en su especificación (como un título o una descripción) es demasiado largo.
Acorte el campo marcado.
The entity type value is invalid
Una extensión x- específica de Adobe para el tipo de entidad tiene un valor no reconocido
Corrija el tipo de entidad con un valor admitido. Consulte la documentación para desarrolladores para ver las opciones válidas.
The provided document is not a valid OpenAPI specification
La especificación no se puede analizar estructuralmente.
Valide su especificación con el esquema OpenAPI 3.0 y corrija cualquier problema.
Required OpenAPI field is missing
Falta un campo obligatorio estándar de OpenAPI (como info o paths).
Añada el campo que falta.
Required endpoint is missing from the specification
Un extremo que Adobe Journey Optimizer B2B edition requiere no está definido en sus especificaciones.
Agregue el punto final requerido. Consulte la documentación para desarrolladores para la cual se necesitan puntos de conexión.
Required extension field is missing
No hay ningún campo de extensión de Adobe x- requerido en su especificación.
Añada el campo de extensión que falta como se describe en la documentación.
Security schemes are missing from the specification
Su especificación no tiene securitySchemes definido en components.
Defina al menos un esquema de seguridad.
Multiple authentication types are not supported
Su especificación define más de un esquema de autenticación.
Actualice la especificación para utilizar un solo tipo de autenticación.
The authentication type is not supported
El tipo de esquema de seguridad que ha utilizado (como oauth2 o openIdConnect) no es compatible.
Cambie a un tipo de autenticación compatible. Consulte la documentación para desarrolladores para ver las opciones admitidas.
The OpenAPI version is not supported
Discrepancia de versiones en el nivel de especificación
Actualice la especificación para utilizar OpenAPI 3.0.x.
An unexpected error occurred
Se ha encontrado un problema no clasificado en su especificación.
Compruebe si hay algo inusual en las especificaciones e inténtelo de nuevo. Si el error persiste, póngase en contacto con el soporte técnico.

Añadir un nodo externo a un recorrido add-journey-node

Una vez activada una acción, los especialistas en marketing pueden agregar un nodo External action o External split path a cualquier recorrido de cuenta. Para obtener información sobre cómo agregar y utilizar estos nodos en el lienzo de recorrido de la cuenta, consulte Nodos externos.

recommendation-more-help
journey-optimizer-b2b-help-user