Actividad de Respuesta API¶

Introducción¶

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

La actividad API Respuesta se puede configurar mediante un esquema JSON, XML, CSV o XSD. Para interactuar con una conexión API utilizando un esquema WSDL, utilice una actividad de respuesta SOAP 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 Manager de API

• Configuración API Personalizada

• Creación de una API Personalizada simple

Crear una Actividad de Respuesta API¶

Se crea una instancia de una actividad API Respuesta a partir de la conexión 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 cópielo y péguelo en el tela de diseño. Para más detalles, consulte Creando una instancia de actividad en Reutilización de componentes.

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

• El tela de diseño (consulte Menú de acciones del componente en Tela de Diseño).
• La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña Componentes del panel de proyecto).

Configurar una Actividad de Respuesta API¶

Siga estos pasos para configurar una actividad API Respuesta:

• 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. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Nombre: Introduzca un nombre para identificar la actividad. El nombre debe ser único para cada actividad API Respuesta 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 API Respuesta. La necesidad de un esquema depende de si la actividad API Respuesta se utiliza como destino de una transformación (consulte Uso del esquema). Para obtener instrucciones sobre cómo completar esta sección de configuración de actividad, consulte Esquemas definidos en una actividad.

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

• Siguiente: Haga clic para almacenar temporalmente la configuración para este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Finalizado 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 pide 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. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquemas de datos: Se muestran los esquemas de solicitud y respuesta para esta actividad. Estos esquemas de datos se heredan mediante transformaciones adyacentes y se muestran nuevamente durante mapeo de transformación.

!!! note "Nota" Los datos proporcionados en una transformación tienen prioridad sobre la configuración de la actividad.

• Agregar complemento(s): Los complementos son aplicaciones de Jitterbit o proporcionadas 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 utilizadas por el complemento, consulte Complementos agregados a una actividad.

• Volver: Haga clic para almacenar 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 pide que confirme que desea descartar los cambios.

Próximos Pasos¶

Después de configurar una actividad API Respuesta, puede usarla dentro de una operación como se describe a continuación. Una vez configurada la operación, selecciónela en la configuración de un API Manager API Personalizada para exponer la operación o cadena de operación como un extremo REST consumible.

Completa la Operación¶

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 operación de una operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en diferentes flujos de trabajo.

Se puede acceder a las acciones del menú para una actividad desde el panel del proyecto y el tela de diseño. Para más detalles, consulte Menú de acciones de actividad en Conceptos básicos del conector.

Las actividades API Respuesta se pueden utilizar como 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 destinos (solo como segundo objetivo)

• Patrón de dos transformaciones (solo como segundo objetivo)

Un caso de uso típico es utilizar una actividad API Respuesta varias veces dentro de una cadena de operación para manejar diferentes respuestas de error. Ambas operaciones en este ejemplo utilizan el Patrón de transformación.

En este ejemplo, en la operación Obtener datos de empleado, el secuencia de comandos Validar parámetros se utiliza para proporcionar entrada para una actividad Consulta de base de datos (Solicitud de consulta), que genera una estructura de respuesta que se recibe mediante la transformación (Base de datos a API). y devuelto a la API Personalizada mediante una actividad API Respuesta (API Response).

Si falla la operación Obtener datos del empleado, se ejecuta la operación Enviar respuesta de falla. El secuencia de comandos Parse Failure Message se utiliza para anular la respuesta del código de error HTTP para una API Personalizada de Jitterbit utilizando la variable Jitterbit jitterbit.api.response.status_code y proporciona la entrada para la transformación Format Failure Response, que luego se devuelve a la API Personalizada mediante una actividad API Respuesta (API Response):

Cuando esté listo, desplegar y ejecutar la operación y validar el comportamiento comprobando los registros de operación.

Ejemplos Adicionales¶

Otros ejemplos que utilizan actividades API como objetivos en una operación incluyen Captura de cambios de datos con una API de Harmony o un Extremo HTTP y Configurar mensajes salientes con la API de Harmony. (Estos patrones utilizan Design Studio como ejemplo, pero los mismos conceptos se pueden aplicar en Cloud Studio).

Configuración de una API Personalizada de API Manager¶

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