Actividad de solicitud de API

Introducción

Una actividad de Solicitud de API, utilizando su conexión de API preconfigurada, recupera datos cuando es llamada por una API personalizada de API Manager y está destinada a ser utilizada como fuente para proporcionar datos a una operación.

La actividad de Solicitud 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 solicitud de API SOAP 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:

• Tipos de API de API Manager

• Configuración de API personalizada

• Construyendo una API personalizada simple

Crear una actividad de solicitud de API

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

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égalo 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 Solicitud de API existente se puede editar desde estas ubicaciones:

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

Configurar una actividad de solicitud de API

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

• Paso 1: Ingresa un nombre y especifica una preferencia de esquema de respuesta
  Proporciona un nombre para la actividad y selecciona una preferencia de esquema de respuesta.

• Paso 2: Revisa los esquemas de datos
  Se muestran los esquemas de solicitud o respuesta generados desde el endpoint.

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

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

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

• Proporcionar esquema de respuesta: El esquema de respuesta define la estructura de los datos que utiliza la actividad de Solicitud de API. Si se requiere un esquema depende de si la actividad de Solicitud de API se utiliza como fuente 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.

• 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.

• 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 va a 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 Solicitud 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 Solicitud 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 Solicitud de API se pueden utilizar como fuente con estos patrones de operación:

• Patrón de archivo
• Patrón de transformación
• Patrón de archivo de dos objetivos (como la primera fuente únicamente)
• Patrón de archivo HTTP de dos objetivos (como la primera fuente únicamente)
• Patrón de dos transformaciones (como la primera fuente únicamente)

Configurar una API personalizada de API Manager

Una vez que la operación esté configurada y desplegada, configura una API personalizada utilizando API Manager.