Show Menu
TEMAS×

API externa

Descripción

La External API actividad aporta datos al flujo de trabajo desde un sistema externo mediante una llamada a la API de REST.
Los extremos REST pueden ser un sistema de administración de clientes, una instancia de Adobe I/O Runtime o extremos de Experience Cloud REST (plataforma de datos, Target, Analytics, Campaign, etc.).
Por motivos de seguridad, el uso de JSSP no se admite en Campaign Standard. Si necesita ejecutar código, puede llamar a una instancia de Adobe I/O Runtime a través de la actividad de API externa.
Esta capacidad está actualmente en versión beta pública. Debe aceptar el contrato de uso antes de empezar a usar la actividad de API externa. Tenga en cuenta que, como Adobe aún no ha lanzado esta funcionalidad beta pública, Adobe Client Care no la admite, puede contener errores y no funcionar como así también otras funciones lanzadas.
Las principales características de esta actividad son:
  • Capacidad para pasar datos en formato JSON a un extremo de API REST de terceros
  • Capacidad para recibir una respuesta JSON, asignarla a tablas de salida y pasar a otras actividades de flujo de trabajo.
  • Administración de errores con una transición específica de salida
Se han establecido las siguientes barreras para esta actividad:
  • Límite de tamaño de datos de respuesta http de 5 MB
  • El tiempo de espera de la solicitud es de 60 segundos
  • No se permiten redirecciones HTTP
  • Se rechazan las direcciones URL que no son HTTPS
  • "Aceptar: application/json" y "Content-Type: el encabezado de respuesta "application/json" está permitido
Tenga en cuenta que la actividad está pensada para obtener datos de toda la campaña (último conjunto de ofertas, puntuaciones más recientes, etc.) no para recuperar información específica para cada perfil, ya que esto puede resultar en la transferencia de grandes cantidades de datos. Si el caso de uso requiere esto, la recomendación es utilizar la actividad Transferir archivo .

Configuración

Arrastre y suelte una External API actividad en el flujo de trabajo y abra la actividad para iniciar la configuración.

Asignación de entrada

La asignación entrante es una tabla temporal generada por una actividad entrante anterior que se mostrará y enviará como JSON en la interfaz de usuario. En función de esta tabla temporal, el usuario puede modificar los datos de entrada.
La lista desplegable Recurso entrante permite seleccionar la actividad de consulta que creará la tabla temporal.
La casilla Agregar parámetro de recuento mostrará un valor de recuento para cada fila que provenga de la tabla temporal. Tenga en cuenta que esta casilla de verificación solo está disponible si la actividad entrante está generando una tabla temporal.
La sección Columnas de entrada permite al usuario agregar cualquier campo de la tabla de transición de entrada. Las columnas seleccionadas serán las claves del objeto de datos. El objeto de datos del JSON será una lista de matrices que contenga datos para las columnas seleccionadas de cada fila de la tabla de transición de entrada.
El cuadro de texto personalizar parámetro permite agregar un JSON válido con los datos adicionales que necesita la API externa. Estos datos adicionales se agregarán al objeto params en el JSON generado.

Asignación de salida

Esta ficha permite definir la estructura de JSON de muestra devuelta por la llamada de API.
El patrón de estructura JSON es: {“data”:[{“key”:“value”}, {“key”:“value”},...]}
La definición JSON de muestra debe tener las siguientes características :
  • data es un nombre de propiedad obligatorio en JSON, el contenido de "data" es una matriz JSON.
  • Los elementos de matriz deben contener propiedades de primer nivel (no se admiten niveles más profundos). Los nombres de propiedad terminarían convirtiéndose en nombres de columna para el esquema de salida de la tabla temporal de salida.
  • La definición del nombre de columna se basa en el primer elemento de la matriz de "datos". La definición de columnas (agregar/quitar) y el valor de tipo de la propiedad se pueden editar en la ficha Definición de columna.
Si el análisis está validado , aparece un mensaje que le invita a personalizar la asignación de datos en la ficha "Definición de columna". En otros casos, se muestra un mensaje de error.

Ejecución

Esta ficha permite definir el extremo HTTPS que enviará datos a ACS. Si es necesario, puede introducir la información de autenticación en los campos siguientes.

Propiedades

Esta ficha permite controlar las propiedades generales de la actividad de API externa, como la etiqueta mostrada en la interfaz de usuario. El ID interno no se puede personalizar.

Definición de columna

Esta ficha aparece cuando se completa y valida el formato de datos de respuesta en la ficha Asignación de salida.
La ficha Definición de columna permite especificar con precisión la estructura de datos de cada columna para importar datos que no contengan errores y hacer que coincidan con los tipos que ya están presentes en la base de datos de Adobe Campaign para futuras operaciones.
Por ejemplo, puede cambiar la etiqueta de una columna y seleccionar su tipo (cadena, entero, fecha, etc.) o incluso especificar el procesamiento de errores.
For more information, refer to the Load File section.

Transición

Esta ficha le permite activar la transición saliente y su etiqueta. Esta transición específica resulta útil en caso de tiempo de espera o si la carga útil supera el límite de tamaño de datos.

Opciones de ejecución

Esta ficha está disponible en la mayoría de las actividades de flujo de trabajo. Para obtener más información, consulte la sección Propiedades de la actividad.

Resolución de problemas

Se agregaron dos tipos de mensajes de registro a esta nueva actividad de flujo de trabajo: información y errores. Pueden ayudarle a solucionar problemas potenciales.

Información

Estos mensajes de registro se utilizan para registrar información sobre puntos de comprobación útiles durante la ejecución de la actividad de flujo de trabajo. Específicamente, los siguientes mensajes de registro se utilizan para registrar el primer intento, así como un intento de reintento (y el motivo del error en el primer intento) para acceder a la API.
Formato del mensaje Ejemplo
Invocando dirección URL de API '%s'.
Invocación de la URL de API 'https://example.com/api/v1/web-coupon?count=2'.
Reintentando la dirección URL de API '%s', error en el intento anterior ('%s').
Reintentando la URL de la API 'https://example.com/api/v1/web-coupon?count=2', error en el intento anterior ('HTTP - 401').
Transfiriendo contenido de '%s' (%s / %s).
Transferencia de contenido desde 'https://example.com/api/v1/web-coupon?count=2' (1234 / 1234).

Errores

Estos mensajes de registro se utilizan para registrar información sobre las condiciones de error inesperadas, lo que puede provocar que la actividad del flujo de trabajo falle.
Código - Formato del mensaje Ejemplo
WKF-560250 - Se ha superado el límite del cuerpo de la solicitud de API (límite: '%d').
Se excedió el límite del cuerpo de la solicitud de API (límite: '5242880').
WKF-560239: respuesta de API superada límite (límite: '%d').
Respuesta de API excedida límite (límite: 5242880').
WKF-560245 - No se pudo analizar la dirección URL de la API (error: '%d').
No se pudo analizar la dirección URL de API (error: '-2010').
Nota: Este error se registra cuando la dirección URL de la API falla en las reglas de validación.
WKF-560244 - El host de URL de API no debe ser 'localhost' ni literal de dirección IP (host de URL: '%s').
El host de URL de API no debe ser 'localhost' ni literal de dirección IP (host de URL: 'localhost').
El host de URL de API no debe ser 'localhost' ni literal de dirección IP (host de URL: "192.168.0.5").
El host de URL de API no debe ser 'localhost' ni literal de dirección IP (host de URL: '[2001]').
WKF-560238 - La dirección URL de la API debe ser una dirección URL segura (https) (dirección URL solicitada: '%s').
La dirección URL de API debe ser una dirección URL segura (https) (dirección URL solicitada: "https://example.com/api/v1/web-coupon?count=2').
WKF-560249 - Error al crear el cuerpo de solicitud JSON. Error al agregar '%s'.
No se pudo crear el cuerpo de solicitud JSON. Error al agregar 'params'.
No se pudo crear el cuerpo de solicitud JSON. Error al agregar 'datos'.
WKF-560246 - La clave de encabezado HTTP es incorrecta (clave de encabezado: '%s').
La clave de encabezado HTTP es mala (clave de encabezado: '%s').
Nota: Este error se registra cuando la clave de encabezado personalizada falla en la validación según RFC
WKF-560248 - No se permite la clave de encabezado HTTP (clave de encabezado: '%s').
No se permite la clave de encabezado HTTP (clave de encabezado: 'Accept').
WKF-560247 - El valor del encabezado AHTTP es incorrecto (valor del encabezado: '%s').
El valor del encabezado HTTP es malo (valor del encabezado: '%s').
Nota: Este error se registra cuando el valor del encabezado personalizado falla en la validación según RFC
WKF-560240 - La carga útil JSON tiene una propiedad incorrecta '%s'.
La carga útil de JSON tiene una propiedad 'blah' incorrecta.
WKF-560241 - Formato JSON incorrecto o inaceptable.
Formato JSON incorrecto o formato inaceptable.
Nota: Este mensaje solo se aplica al análisis del cuerpo de respuesta desde la API externa y se registra al intentar validar si el cuerpo de respuesta se ajusta al formato JSON establecido por esta actividad.
WKF-560246 - Error de actividad (motivo: '%s').
Cuando falla la actividad debido a la respuesta de error HTTP 401: error de la actividad (motivo: 'HTTP - 401')
Cuando la actividad falla debido a una llamada interna fallida - Error de actividad (motivo: 'Rc - -Nn').
Cuando la actividad falla debido a un encabezado Content-Type no válido. - Error de actividad (motivo: 'Content-Type - application/html').