API externa

Descripción

La actividad de External API introduce datos en el flujo de trabajo desde un sistema externo a través de una llamada de API HTTP.

Los extremos externos del sistema pueden ser extremos de API públicos, sistemas de administración de clientes o instancias de aplicaciones sin servidor (por ejemplo, Adobe I/O Runtime), por mencionar algunas categorías.

Nota

Por motivos de seguridad, el uso de JSSP no es compatible con 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.

Las principales características de esta actividad son:

  • Capacidad para pasar datos en formato JSON a un extremo de API de 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.

Avisos de compatibilidad con versiones anteriores

With the Campaign Standard 20.4 release, the http response data size limit and response timeout guardrails have been lowered to align with best practices - see Limitations and guardrails. Estas modificaciones de la limitación no tendrán efecto en las actividades de API externas existentes; por lo tanto, se recomienda reemplazar las actividades de API externas existentes con nuevas versiones en todos los flujos de trabajo.

Al reemplazar actividades de API externas, añada la nueva actividad de API externa al flujo de trabajo, copie manualmente los detalles de configuración y, a continuación, elimine la actividad antigua.

Nota

No podrá copiar sobre los valores del encabezado específicos de la actividad, ya que están enmascarados dentro de la actividad.

Limitaciones y barreras

Esta actividad se rige por las siguientes limitaciones:

  • Límite de tamaño de datos de respuesta http de 5 MB (Nota: Esto supone un cambio con respecto al límite de 50 MB de la versión anterior).
  • El tiempo de espera de la solicitud es de 1 minuto (Nota: Esto supone un cambio con respecto al tiempo de espera de 10 minutos de la versión anterior).
  • No se permiten redirecciones HTTP.
  • Se rechazan las direcciones URL que no son HTTPS.
  • Están permitidos el encabezado de solicitud “Accept: application/json” y el encabezado de respuesta “Content-Type: application/json”.

Se han establecido limitaciones específicas:

  • Profundidad máxima de JSON: limitar la profundidad máxima de un archivo JSON personalizado anidado que se puede procesar a 10 niveles.
  • Longitud máxima de clave JSON: limitar la longitud máxima de la clave interna generada a 255. Esta clave está asociada al ID de columna.
  • Se permiten las claves de duplicado máximas de JSON: limitar el número total máximo de nombres de propiedades JSON de duplicado, que se utilizan como ID de columna, a 150.
PRECAUCIÓN

La actividad de la API externa está diseñada 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 conllevar transferir grandes cantidades de datos. Si fuera necesario, se recomienda utilizar la actividad Transferir archivo.

Configuración

Arrastre y suelte una actividad de External API en el flujo de trabajo y ábrala para comenzar con la configuración.

Asignación de entrada

La asignación de entrada es una tabla temporal generada por una actividad de entrada anterior que se muestra y envía como JSON en la interfaz de usuario.
En función de esta tabla temporal, el usuario puede realizar modificaciones en los datos de entrada.

La lista desplegable Recurso de entrada permite seleccionar la actividad de consulta que crea la tabla temporal.

La casilla de verificación Añadir parámetro de recuento añade un valor de recuento para cada fila proveniente de la tabla temporal. Tenga en cuenta que esta casilla de verificación solo está disponible si la actividad de entrada genera una tabla temporal.

La sección Columnas de entrada permite al usuario añadir cualquier campo de la tabla de transición de entrada. Las columnas seleccionadas son las claves del objeto de datos. El objeto de datos en el archivo JSON es una lista de matriz que contiene datos para las columnas seleccionadas de cada fila de la tabla de transición de entrada.

El cuadro de texto Personalizar parámetro le permite añadir un archivo JSON válido con los datos adicionales que necesita la API externa. Estos datos adicionales se añaden al objeto parámetros en el archivo JSON generado.

Asignación de salida

Esta pestaña le permite definir la estructura JSON de muestra devuelta por la llamada de API.

El analizador JSON está diseñado para admitir tipos de patrones de estructura JSON estándar, con algunas excepciones. Un ejemplo de patrón estándar es:{“data”:[{“key”:“value”}, {“key”:“value”},...]}

La definición JSON de muestra debe tener las siguientes características:

  • Los elementos de matriz deben contener propiedades de primer nivel (no se admiten niveles más profundos).
    Los nombres de propiedades terminan convirtiéndose en nombres de columna para el esquema de salida de la tabla temporal.
  • Los elementos JSON que se van a recopilar deben tener 10 niveles o menos de anidación dentro de la respuesta JSON.
  • La definición del nombre de columna se basa en el primer elemento de la matriz de “datos”.
    La definición de columnas (añadir/quitar) y el valor de tipo de la propiedad se pueden editar en la pestaña Definición de columna.

El comportamiento de la casilla Acoplar:

La casilla Acoplar (sin marcar por defecto) sirve para indicar si desea acoplar el archivo JSON a un mapa de clave/valor o no.

  • Cuando la casilla de verificación está desactivada (sin marcar), el archivo JSON de muestra se analiza para buscar un objeto de matriz. El usuario debe proporcionar una versión recortada como muestra de la respuesta de API en formato JSON para que Adobe Campaign pueda determinar exactamente qué matriz le interesa utilizar. En el momento de la creación del flujo de trabajo, se determina y registra la ruta al objeto de matriz anidado, de modo que se pueda utilizar en el momento de la ejecución para acceder a ese objeto de matriz desde el cuerpo de respuesta JSON recibido de la llamada de API.

  • Cuando la casilla de verificación está activada (marcada), el archivo JSON de muestra se acopla y todas las propiedades especificadas en el archivo de muestra proporcionado se utilizan para crear columnas de la tabla temporal de salida y se muestran en la pestaña Definiciones de columna. Tenga en cuenta que si hay algún objeto de matriz en el archivo JSON de muestra, también se acoplan todos los elementos de esos objetos de matriz.

Si se valida el análisis, aparece un mensaje que le invita a personalizar la asignación de datos en la pestaña “Definición de columna”. En otros casos, se muestra un mensaje de error.

Ejecución

Esta pestaña permite definir el extremo de la conexión. El campo URL permite definir el extremo HTTPS que enviará datos a ACS.

Si lo necesita el extremo, hay dos tipos de método de autenticación disponibles.

  • Autenticación básica: introduzca la información de nombre de usuario y contraseña en el campo Request Header(s) .

  • Autenticación de OAuth: Al hacer clic en Use connection parameters defined in an external account, puede seleccionar una cuenta externa donde se define la autenticación OAuth. Para obtener más información, consulte la sección Cuentas externas .

Propiedades

Esta pestaña le permite controlar las propiedades generales de la actividad de API externa, como las que se muestran en la interfaz de usuario. El ID interno no se puede personalizar.

Definición de columna

Nota

Esta pestaña aparece cuando se completa y valida el formato de datos de respuesta en la pestaña Asignación de salida.

La pestaña Definición de columna le 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.

Para obtener más información, consulte la sección Cargar archivo.

Transición

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

Opciones de ejecución

Esta pestaña 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 actividad.

Resolución de problemas

Se han añadido 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 del flujo de trabajo.

Formato del mensaje
Ejemplo
Invoking API URL '%s'.

Invocando la dirección URL de la API “https://example.com/api/v1/web-coupon?count=2”.

Retrying API URL '%s' due to %s in %d ms, attempt %d.

Reintentando la URL de la API “https://example.com/api/v1/web-coupon?count=0” due to HTTP - 401 in 2364 ms, intento 2.

Transferring content from '%s' (%s / %s).

Transferencia de contenido desde “https://example.com/api/v1/web-coupon?count=2” (1234 / 1234).

Using cached access token for provider ID '%s'.

Usando token de acceso en caché para el identificador de proveedor “EXT25”. Nota: EXT25 es la ID (o nombre) de la cuenta externa.

Fetched access token from server for provider ID '%s'.

Se obtuvo el token de acceso del servidor para el identificador de proveedor “EXT25”. Nota: EXT25 es la ID (o nombre) de la cuenta externa.

Refreshing OAuth access token due to error (HTTP: '%d').

Actualización del token de acceso de OAuth debido a un error (HTTP: “401”).

Error refreshing OAuth access token (error: '%d').

Error al actualizar el token de acceso de OAuth (error: “404”).

Failed to fetch the OAuth access token using the specified external account on attempt %d, retrying in %d ms.

No se pudo recuperar el token de acceso de OAuth usando la cuenta externa especificada en el intento 1, reintentando en 1387 ms.

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 - API request body exceeded limit (limit: '%d').

Se ha superado el límite del cuerpo de la solicitud de API (límite: “5242880”).

WKF-560239 - API response exceeded limit (limit: '%d').

Se ha superado el límite de respuesta de API (límite: “5242880”).

WKF-560245 - API URL could not be parsed (error: '%d').

No se ha podido analizar la dirección URL de la 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 - API URL host must not be 'localhost', or IP address literal (URL host: '%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 - API URL must be a secure URL (https) (requested URL: '%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 la solicitud JSON. Error when adding '%s'.

No se ha podido crear el cuerpo de la solicitud JSON. Error al añadir “parámetros”.

No se ha podido crear el cuerpo de la solicitud JSON. Error al añadir “datos”.

WKF-560246 - HTTP header key is bad (header key: '%s').

HTTP header key is bad (header key: '%s').

Nota: Este error se registra cuando la clave de encabezado personalizada falla en la validación según RFC.

WKF-560248 - HTTP header key is not allowed (header key: '%s').

No se permite la clave de encabezado HTTP (clave de encabezado: “Accept”).

WKF-560247 - A HTTP header value is bad (header value: '%s').

HTTP header value is bad (header value: '%s').

Nota: Este error se registra cuando el valor del encabezado personalizado falla en la validación según RFC.

WKF-560240 - JSON payload has bad property '%s'.

La carga de JSON tiene una propiedad “blah” incorrecta.

WKF-560241 - Malformed JSON or unacceptable format.

Formato JSON no correcto o no compatible.

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 - Activity failed (reason: '%s').

Cuando falla la actividad debido a la respuesta de error HTTP 401: error de actividad (motivo: “HTTP - 401”)

Cuando falla la actividad debido a una llamada interna fallida: error de actividad (motivo: “iRc - -Nn”).

Cuando falla la actividad debido a un encabezado de Content-Type no válido: error de actividad (motivo: “Content-Type - application/html”).

WKF-560278 - "Error initializing OAuth helper (error: '%d')" .

Este error indica que la actividad no pudo inicializar la función de ayuda OAuth2.0 interna debido a un error al usar los atributos configurados en la cuenta externa para inicializar el asistente.

WKF-560279 - "HTTP header key is not allowed (header key: '%s')."

Este mensaje de advertencia (no de error) indica que la cuenta externa OAuth 2.0 se ha configurado para agregar una credencial como un encabezado HTTP, pero la clave del encabezado utilizada no está permitida porque es una clave de encabezado reservada.

WKF-560280 - External account of '%s' ID cannot be found.

No se encuentra la cuenta externa del identificador “EXT25”. Nota: Este error indica que la actividad está configurada para utilizar una cuenta externa, que ya no se puede encontrar. Es muy probable que esto ocurra cuando la cuenta se elimina de la base de datos y, como tal, no es probable que ocurra en circunstancias normales de funcionamiento.

WKF-560281 - External account of '%s' ID is disabled.

La cuenta externa del identificador “EXT25” está deshabilitada. Nota: Este error indica que la actividad está configurada para usar una cuenta externa, pero que esa cuenta se ha deshabilitado (o marcado como inactiva).

WKF-560282 - Protocol not supported.

Este error indica que la cuenta externa asociada con la actividad no es una cuenta externa OAuth2.0. Como tal, es improbable que este error ocurra a menos que haya algún daño o cambios manuales en la configuración de la actividad.

WKF-560283 - Failed to fetch the OAuth access token.

La causa más común de este error es la configuración incorrecta de la cuenta externa (por ejemplo, uso de la cuenta externa sin comprobar que la conexión se haya realizado correctamente). Es posible que se cambien las direcciones URL/credenciales de la cuenta externa.

CRL-290199 - Cannot reach page at: %s.

Este mensaje de error se muestra en la pantalla de la interfaz de usuario de cuentas externas al configurarlo para OAuth. Significa que la dirección URL del servidor de autorización externo es incorrecta, está modificada o la respuesta del servidor es Página no encontrada.

CRL-290200 - Incomplete/Incorrect credentials.

Este mensaje de error se muestra en la pantalla de la interfaz de usuario de cuentas externas al configurarlo para OAuth. Esto significa que las credenciales son incorrectas o que faltan otras credenciales necesarias para conectarse al servidor de autenticación.

En esta página