Actividad de solicitud SOAP de API
Introducción
Una actividad de API Solicitud SOAP, que utiliza su conexión API preconfigurada, recupera datos cuando es llamado por una API personalizada de API Manager y está destinado a ser utilizado como un objetivo para consumir datos en una operación.
La actividad Solicitud SOAP de la API se puede configurar utilizando únicamente un esquema WSDL. Para interactuar con una conexión de API mediante un esquema JSON, XML, CSV o XSD, utilice una actividad de Solicitud de API que no sea 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 del conector API y las APIs de API Manager, consulte estos recursos:
Crear una actividad de solicitud SOAP de API
Se crea una instancia de una actividad de API Solicitud SOAP **a partir de la conexión API preconfigurada utilizando su tipo de actividad Solicitud SOAP**.
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 Solicitud SOAP 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 solicitud SOAP de API
Siga estos pasos para configurar una actividad de API Solicitud SOAP:
-
Paso 1: Ingrese un nombre y especifique la configuración
Proporcione un nombre para la actividad y seleccione el método que se utilizará para cargar el esquema WSDL. -
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 la configuración
En este paso, proporcione un nombre para la actividad y seleccione el método que se utilizará para cargar el esquema WSDL. 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 API Solicitud SOAP y no debe contener barras diagonales
/
o dos puntos:
. -
Subir URL, Subir archivo o Seleccionar existente: Use el botón de opción para seleccionar la fuente del archivo WSDL que desea subir o reutilizar. Se pueden subir archivos de hasta 5 MB de tamaño.
-
Subir URL: Ingrese la URL del archivo WSDL en el cuadro de texto y luego haga clic en Subir. La URL debe ser accesible sin autenticación o recibirá un error en tiempo de ejecución. Si sube un WSDL con el mismo nombre que un WSDL existente, consulte Posibles errores más adelante en esta página.
-
Subir archivo: Haga clic en Explorar (ubicado a la derecha) para buscar localmente un archivo WSDL o ZIP. Si proporciona un archivo ZIP, debe contener un solo archivo WSDL (aunque puede contener cualquier archivo XSD del que dependa el WSDL). Luego, haga clic en Subir.
Nota
Cualquiera
schemaLocation
debe resolverse en un archivo local mediante 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'
Usted proporcionaría:
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 en el mismo directorio o en una ruta relativa al WSDL que se está cargando. -
Seleccionar existente: Utilice el menú desplegable para seleccionar un archivo WSDL existente que se haya utilizado previamente en el proyecto actual.
-
-
Puerto: Utilice el menú desplegable para seleccionar el puerto apropiado.
-
Servicio y enlace: De forma predeterminada, estos campos se completan automáticamente según el WSDL y el puerto proporcionados y no se pueden editar.
-
Operación: Utilice el menú desplegable para seleccionar el método del WSDL proporcionado que desea ejecutar con esta 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 guardar temporalmente la configuración de 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 los 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:
-
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.
-
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.
Posibles errores
Las siguientes secciones cubren los 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 mediante Cargar URL o Cargar archivo, y las operaciones del WSDL de reemplazo no tienen el mismo nombre que las que usan las actividades existentes, o si faltan operaciones WSDL en uso en el WSDL de reemplazo, puede ocurrir este error:
This WSDL cannot be replaced because it is missing WSDL operations that are use by existing activities. Delete these activities from the project pane's Components tab and try again.
Para resolverlo, asegúrese de que las operaciones WSDL tengan el mismo nombre que las que están siendo utilizadas actualmente por las actividades existentes.
Error al desplegar
Al desplegar una operación cuyo archivo WSDL de la actividad Solicitud SOAP ha sido reemplazado, es posible que reciba este error:
Failed to deploy - Client Error: There is no uploaded file with client path ... Upgrade to the 8.4.0 Studio or higher and deploy the project again.
Para resolverlo, siga estos pasos:
-
Abra la actividad donde se ha reemplazado el archivo WSDL.
-
En el paso 1, vuelva a seleccionar el archivo WSDL que se utilizará para la actividad y luego haga clic en Siguiente.
-
En el paso 2, haga clic en Finalizar.
-
Desplegar la operación.
Próximos pasos
Después de configurar una actividad de API Solicitud SOAP, complete la configuración de la operación agregando y configurando otras actividades o herramientas 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.
Se puede acceder a las acciones del menú de una actividad desde el panel del proyecto y el tela de diseño. Para obtener más información, consulte menú de acciones de la actividad en Conceptos básicos del conector.
Las actividades de API Solicitud SOAP se pueden utilizar como objetivo con estos patrones de operación:
- Patrón de archivo
- Patrón de Transformación
- Patrón de archivo de dos objetivos (solo como primera fuente)
- Patrón de archivo HTTP de dos destinos (solo como primera fuente)
- Patrón de dos transformaciones (solo como primera fuente)
Cuando esté listo, desplegar la operación y validar el comportamiento comprobando los registros de operación.
Nota
Las operaciones con una actividad API Solicitud SOAP como su primer etapa de operación no se pueden ejecutar manualmente mediante las opciones de operación Desplegar y ejecutar o Ejecutar. En cambio, estas operaciones requieren datos que se proporcionan cuando se realiza una llamada a la API mediante una API personalizada creada a través de API Manager. Se puede llamar a una API desde una aplicación o, si la API admite GET, puede pegar la URL en un navegador web para consumir la API manualmente.
Importante
De forma predeterminada, las operaciones exitosas configuradas para una API personalizada no están incluidos en los registros de operación a menos que una de estas configuraciones esté habilitada:
- Agentes de la nube: Para las operaciones de API en un agente de la nube, registro de depurar de operación debe estar habilitado en la operación.
- Agentes privados: Para las operaciones de API en un agente privado, registro de depurar de la operación debe estar habilitado en la operación o debe configurar
EnableLogging=true
en el[APIoperation]
sección del archivo de configuración del agente privado.
Configurar una API personalizada de API Manager
Una vez configurada e implementada la operación, configure una API personalizada usando API Manager.
Nota
Después de haber configurado una API personalizada para llamar an Integration Studio operación, no puede 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.