Saltar al contenido

Actividad de solicitud API SOAP

Introducción

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

La actividad de Solicitud API SOAP puede ser configurada utilizando únicamente un esquema WSDL. Para interactuar con una conexión API utilizando un esquema JSON, XML, CSV o XSD, utiliza una actividad de solicitud API no SOAP en su lugar. Para interactuar con una conexión SOAP sin utilizar una API personalizada, utiliza el conector SOAP.

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

Crear una actividad de solicitud API SOAP

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

Para crear una instancia de una actividad, arrastra el tipo de actividad al lienzo de diseño o copia el tipo de actividad y pégalo en el lienzo de diseño. Para más detalles, consulta Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Solicitud API SOAP existente puede ser editada desde estas ubicaciones:

Configurar una actividad de solicitud API SOAP

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

Paso 1: Ingresa un nombre y especifica configuraciones

En este paso, proporciona un nombre para la actividad y selecciona el método que se utilizará para cargar el esquema WSDL. 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 SOAP API y no debe contener barras diagonales / ni dos puntos :.

  • URL de carga, Archivo de carga o Seleccionar existente: Usa el botón de opción para seleccionar la fuente del archivo WSDL a cargar o reutilizar. Se pueden cargar archivos de hasta 5 MB de tamaño.

    • URL de carga: Ingresa la URL del archivo WSDL en el cuadro de texto, luego haz clic en Cargar. La URL debe ser accesible sin autenticación, o recibirás un error en tiempo de ejecución. Si cargas un WSDL con el mismo nombre que un WSDL existente, consulta Posibles errores más adelante en esta página.

    • Archivo de carga: Haz clic en Examinar (ubicado a la derecha) para buscar localmente un archivo WSDL o ZIP. Si proporcionas un archivo ZIP, debe contener un solo archivo WSDL (aunque puede contener cualquier archivo XSD del que dependa el WSDL). Luego haz clic en Cargar.

      Nota

      Cualquier schemaLocation debe resolverse a un archivo local utilizando una referencia relativa. Esto generalmente significa que en lugar de proporcionar una tupla como:

      xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'

      deberías proporcionar:

      xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'

      En el ejemplo anterior, el archivo XSD wsdlmime-2004-08-24.xsd se encuentra ya sea en el mismo directorio o en una ruta relativa al WSDL que se está cargando.

    • Seleccionar existente: Utiliza el menú desplegable para seleccionar un archivo WSDL existente que se haya utilizado previamente en el proyecto actual.

  • Puerto: Utiliza el menú desplegable para seleccionar el puerto apropiado.

  • Servicio y Enlace: Por defecto, estos campos se completan automáticamente según el WSDL y el puerto proporcionados y no se pueden editar.

  • Operación: Utiliza el menú desplegable para seleccionar el método del WSDL proporcionado que deseas ejecutar con esta 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

Cualquier esquema de solicitud o respuesta generado desde el punto final se muestra:

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

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

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

Posibles errores

Las siguientes secciones cubren errores que pueden ocurrir durante la configuración de la actividad.

No se puede cargar WSDL

Cuando se reemplaza un WSDL volviendo a cargar uno con el mismo nombre utilizando Upload URL o Upload File, y las operaciones del WSDL de reemplazo no tienen el mismo nombre que las que están en uso por actividades existentes, o si faltan operaciones del WSDL en uso en el WSDL de reemplazo, puede ocurrir este error:

Este WSDL no puede ser reemplazado porque faltan operaciones WSDL que son utilizadas por actividades existentes. Elimine estas actividades de la pestaña Componentes del panel del proyecto y vuelva a intentarlo.

Para resolver, asegúrese de que las operaciones WSDL tengan el mismo nombre que cualquiera que esté actualmente en uso por actividades existentes.

Falló al desplegar

Al desplegar una operación cuyo archivo WSDL de la actividad SOAP Request ha sido reemplazado, puede recibir este error:

Falló al desplegar - Error del cliente: No hay un archivo cargado con la ruta del cliente ... Actualice a la versión 8.4.0 de Studio o superior y despliegue el proyecto nuevamente.

Para resolver, siga estos pasos:

  1. Abra la actividad donde se ha reemplazado el archivo WSDL.

  2. En paso 1, seleccione nuevamente el archivo WSDL que se utilizará para la actividad y luego haga clic en Next.

  3. En paso 2, haga clic en Finish.

  4. Despliegue la operación.

Próximos pasos

Después de configurar una actividad de API SOAP Request, complete la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulte el menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades de API SOAP Request pueden ser utilizadas como un objetivo con estos patrones de operación:

Cuando esté listo, despliegue la operación y valide el comportamiento revisando los registros de operación.

Nota

Las operaciones con una actividad de Solicitud SOAP como su primer paso de operación no pueden ser ejecutadas manualmente utilizando las opciones de operación Desplegar y Ejecutar o Ejecutar. En su lugar, estas operaciones requieren datos que se proporcionan cuando se realiza una llamada API utilizando una API personalizada creada a través de API Manager. Una API puede ser llamada desde una aplicación o — si la API soporta GET — puede pegar la URL en un navegador web para consumir la API manualmente.

Importante

Por defecto, 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 de API Manager

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

Nota

Después de haber configurado una API personalizada para llamar a una operación de Integration Studio, no puedes 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.