Actividad de respuesta de API

Introducción

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

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

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

• Tipos de API de API Manager

• Configuración de API personalizada

• Construcción de una API personalizada sencilla

Crear una actividad de respuesta de API

Se crea una instancia de una actividad de Respuesta de API 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 tela de diseño o copie el tipo de actividad y péguelo en el tela de diseño. Para obtener más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Se puede editar una actividad de Respuesta de API existente desde estas ubicaciones:

• El tela de diseño (vea menú de acciones del componente en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (vea menú de acciones de componentes en la pestañaComponentes del panel Proyecto).

Configurar una actividad de respuesta de API

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

• Paso 1: Ingrese un nombre y especifique una preferencia de esquema de solicitud
  Proporcione un nombre para la actividad y seleccione una preferencia de esquema de solicitud.

• Paso 2: Revisar los esquemas de datos
  Se muestran todos los esquemas de solicitud o respuesta generados desde el extremo.

Paso 1: Ingrese un nombre y especifique una preferencia de esquema de solicitud

En este paso, proporcione un nombre para la actividad y seleccione una preferencia de esquema de solicitud. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

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

• Proporcionar esquema de solicitud: El esquema de solicitud define la estructura de datos que utiliza la actividad Respuesta de API. La necesidad de un esquema depende de si la actividad Respuesta de API se utiliza como destino de una transformación. Para obtener instrucciones sobre cómo completar esta sección de configuración de la actividad, consulte Uso del esquema y Esquemas definidos en una actividad.

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

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

• Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 2: Revisar los esquemas de datos

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

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

  Nota

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

• Agregar complemento(s): Los complementos son aplicaciones proporcionadas por Jitterbit o por el usuario que amplían las capacidades nativas de Harmony. Para aplicar un complemento a la actividad, haga clic para expandir esta sección y seleccione la casilla de verificación junto al complemento que se utilizará. Para obtener instrucciones adicionales sobre el uso de complementos, incluidos detalles sobre cómo configurar las variables requeridas que utiliza el complemento, consulte Complementos agregados a una actividad.

• Atrás: Haga clic para guardar temporalmente la configuración de este paso y volver al paso anterior.

• Terminado: Haga 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, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Próximos pasos

Después de configurar una actividad de Respuesta de API, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en flujos de trabajo diferentes.

Una vez que se ha creado una actividad de Respuesta de API, se puede acceder a las acciones del menú para esa actividad desde el panel del proyecto en las pestañas Flujos de trabajo o Componentes y el tela de diseño. Consulte menú de acciones de la actividad para más detalles.

Las actividades de Respuesta de API se pueden usar como un objetivo con estos patrones de operación:

• Patrón de archivo
• Patrón de Secuencia de comandos
• Patrón de Transformación
• Patrón de archivo de dos objetivos (solo como segundo objetivo)
• Patrón de archivo HTTP de dos objetivos (solo como segundo objetivo)
• Patrón de dos transformaciones (solo como segundo objetivo)

Configurar una API personalizada de API Manager

Una vez completada la configuración de la operación, configure una API personalizada usando API Manager.