Actividad de respuesta API SOAP
Introducción
Una actividad de respuesta API SOAP, utilizando su conexión API preconfigurada, devuelve datos a 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 respuesta API SOAP se puede configurar utilizando únicamente un esquema WSDL. Para interactuar con una conexión API utilizando un esquema JSON, XML, CSV o XSD, utilice una actividad de respuesta API no SOAP en su lugar. Para interactuar con una conexión SOAP sin utilizar una API personalizada, utilice el conector SOAP.
Para obtener información sobre la relación entre las actividades de conector API y las APIs de API Manager, consulte estos recursos:
Crear una actividad de respuesta API SOAP
Una instancia de una actividad de respuesta API SOAP se crea a partir de la conexión API preconfigurada utilizando su tipo de actividad respuesta SOAP.
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 API SOAP existente se puede editar desde estas ubicaciones:
- El lienzo de diseño (consulte Menú de acciones de componentes en Lienzo de diseño).
- La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).
Configurar una actividad de respuesta API SOAP
Sigue estos pasos para configurar una actividad de Respuesta SOAP API:
- Paso 1: Ingresa un nombre y especifica configuraciones
Proporciona un nombre para la actividad y selecciona el método que se utilizará para cargar el esquema WSDL. - 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 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 Respuesta SOAP API y no debe contener barras diagonales
/
ni dos puntos:
. -
URL de carga, Cargar archivo o Seleccionar existente: Usa el botón de opción para seleccionar la fuente del archivo WSDL (Lenguaje de Descripción de Servicios Web) para 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 el botón Cargar. La URL debe ser accesible sin autenticación, o recibirás un error. Si cargas un WSDL con el mismo nombre que un WSDL existente, consulta Posibles errores más adelante en esta página.
-
Cargar archivo: Usa el botón Examinar a la derecha para buscar localmente un archivo WSDL o ZIP. Si proporcionas un archivo ZIP, debe contener un solo archivo WSDL, aunque también puede contener cualquier archivo XSD del que dependa el WSDL. Luego haz clic en el botón Cargar. Si cargas un WSDL con el mismo nombre que un WSDL existente, consulta Posibles errores más adelante en esta página.
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'
se debe 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 pide que confirmes que deseas descartar los cambios.
Paso 2: Revisar los esquemas de datos
Cualquier esquema de solicitud o respuesta generado desde el endpoint 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 mapeo de transformaciones.
Nota
Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.
-
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 pide que confirmes que deseas descartar los cambios.
Errores posibles
Las siguientes secciones cubren errores que pueden ocurrir durante la configuración de la actividad.
No se puede cargar WSDL
Al reemplazar un WSDL volviendo a cargar uno con el mismo nombre usando Cargar URL o Cargar Archivo, y las operaciones del WSDL de reemplazo no tienen el mismo nombre que las que están en uso por actividades existentes, o si las operaciones del WSDL en uso faltan en el WSDL de reemplazo, puede ocurrir este error:
Este WSDL no se puede reemplazar porque faltan operaciones WSDL que son utilizadas por actividades existentes. Elimina estas actividades de la pestaña Componentes del panel del proyecto y vuelve a intentarlo.
Para resolver, asegúrate de que las operaciones WSDL tengan el mismo nombre que cualquiera que esté actualmente en uso por actividades existentes.
Falló el despliegue
Al desplegar una operación cuyo archivo WSDL de la actividad Solicitud SOAP ha sido reemplazado, puedes recibir este error:
Falló el despliegue - Error del Cliente: No hay archivo cargado con la ruta del cliente ... Actualiza a la versión 8.4.0 de Studio o superior y despliega el proyecto nuevamente.
Para resolver, sigue estos pasos:
-
Abre la actividad donde se ha reemplazado el archivo WSDL.
-
En paso 1, vuelve a seleccionar el archivo WSDL que se utilizará para la actividad y luego haz clic en Siguiente.
-
En paso 2, haz clic en Finalizar.
-
Despliega la operación.
Próximos pasos
Después de configurar una actividad de Respuesta SOAP de API, completa la configuración de la operación añadiendo y configurando otras actividades o herramientas como pasos de la operación. También puedes 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, consulta el menú de acciones de actividad en Conceptos básicos de conectores.
Las actividades de respuesta SOAP pueden ser utilizadas como un objetivo con estos patrones de operación:
- Patrón de archivo
- Patrón de script
- Patrón de transformación
- Patrón de archivo de dos objetivos (solo como el segundo objetivo)
- Patrón de archivo HTTP de dos objetivos (solo como el segundo objetivo)
- Patrón de dos transformaciones (solo como el segundo objetivo)
Cuando esté listo, despliega la operación y valida el comportamiento revisando los registros 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:
- Agentes en la nube: Para operaciones de API en un agente en la nube, se debe habilitar el registro de depuración de operaciones en la operación.
- Agentes privados: Para operaciones de API en un agente privado, se debe habilitar el registro de depuración de operaciones en la operación o se debe establecer
EnableLogging=true
en la sección[APIoperation]
del archivo de configuración del agente privado.
Configurar una API personalizada del 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.