Saltar al contenido

Actividad de Respuesta de API

Introducción

Una actividad de Respuesta de API, utilizando su conexión de API preconfigurada, devuelve datos a una API personalizada de API Manager y está destinada a ser utilizada como objetivo para consumir datos en una operación.

La actividad de Respuesta de API se puede configurar utilizando un esquema JSON, XML, CSV o XSD. Para interactuar con una conexión de API utilizando un esquema WSDL, utilice una actividad de Respuesta SOAP de API en su lugar.

Para obtener información sobre la relación entre las actividades de conector de API y las APIs de API Manager, consulte estos recursos:

Crear una actividad de Respuesta de API

Una instancia de una actividad de Respuesta de API se crea a partir de la conexión de API preconfigurada utilizando su tipo de actividad Respuesta.

Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Respuesta de API existente se puede editar desde estas ubicaciones:

Configurar una actividad de respuesta de API

Sigue estos pasos para configurar una actividad de Respuesta de API:

Paso 1: Ingresa un nombre y especifica una preferencia de esquema de solicitud

En este paso, proporciona un nombre para la actividad y selecciona una preferencia de esquema de solicitud. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

Configuración de la actividad de respuesta de API paso 1

  • Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Respuesta de API y no debe contener barras inclinadas / o dos puntos :.

  • Proporcionar esquema de solicitud: El esquema de solicitud define la estructura de los datos que utiliza la actividad de Respuesta de API. Si se requiere un esquema depende de si la actividad de Respuesta de API se utiliza como el objetivo de una transformación. Para instrucciones sobre cómo completar esta sección de la configuración de la actividad, consulta Uso de esquemas y Esquemas definidos en una actividad.

  • Guardar y salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

  • Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

  • Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 2: Revisar los esquemas de datos

Se muestran los esquemas de solicitud o respuesta generados desde el endpoint. A continuación se describe cada elemento de la interfaz de usuario de este paso.

Configuración de actividad de respuesta de API paso 2

  • Esquemas de Datos: Se muestran los esquemas de solicitud y respuesta para esta actividad. Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

    Nota

    Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

  • Agregar plugin(s): Los plugins son aplicaciones proporcionadas por Jitterbit o por el usuario que amplían las capacidades nativas de Harmony. Para aplicar un plugin a la actividad, haz clic para expandir esta sección y selecciona la casilla junto al plugin que se utilizará. Para instrucciones adicionales sobre el uso de plugins, incluidos los detalles sobre la configuración de cualquier variable requerida por el plugin, consulta Plugins añadidos a una actividad.

  • Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

  • Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad de Respuesta de API, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar la configuración de la operación, que incluye la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Una vez que se ha creado una actividad de Respuesta de API, las acciones del menú para esa actividad son accesibles desde el panel del proyecto en las pestañas de Flujos de trabajo o Componentes, y en el lienzo de diseño. Consulta Menú de acciones de actividad para más detalles.

Las actividades de respuesta de la API se pueden utilizar como un objetivo con estos patrones de operación:

Importante

De forma predeterminada, las operaciones exitosas configuradas para una API personalizada no se incluyen en los registros de operación a menos que se habilite una de estas configuraciones:

Las operaciones no exitosas se incluyen en los registros de operación independientemente de si las configuraciones anteriores están habilitadas o no.

Configurar una API personalizada del Administrador de API

Una vez que la operación está configurada y desplegada, configura una API personalizada utilizando Administrador de API.

Nota

Después de haber configurado una API personalizada para llamar a una operación de Integration Studio, no se puede eliminar la operación sin eliminar la API o cambiar la configuración de la API para que ya no llame a la operación.