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 API Solicitud SOAP 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 Solicitud SOAP de API 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 va a subir un WSDL con el mismo nombre que un WSDL existente, consulte Reemplazar un WSDL subido 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.
Reemplazar un WSDL cargado
Si reemplaza un WSDL volviendo a cargar uno con el mismo nombre mediante Upload URL o Upload File, sus operaciones WSDL deben tener el mismo nombre que las que están actualmente en uso por las actividades existentes. Si no tienen el mismo nombre o si faltan operaciones WSDL en uso en el WSDL de reemplazo, un mensaje de error le indica que primero elimine esas actividades:
Si se cumplen los criterios de reemplazo de WSDL descritos anteriormente, un mensaje de confirmación enumera las actividades que pueden verse afectadas por el reemplazo del WSDL y sugiere revisar las transformaciones adyacentes para detectar posibles errores de mapeo. Al hacer clic en Continuar se reemplaza el WSDL en todas las ubicaciones donde se utiliza en todo el proyecto:
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, transformaciones o secuencias de comandos 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.
Una vez que se ha creado una actividad de API Solicitud SOAP, se puede acceder a las acciones del menú para esa actividad desde el panel del proyecto en las pestañas** Flujos de trabajo** o Componentes y el tela de diseño. Consulte menú de acciones de la actividad para más detalles.
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)
Nota
Las operaciones que comienzan con una actividad de API Solicitud SOAP 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.
Ejemplos adicionales
Otros ejemplos que utilizan actividades de API como objetivos en una operación incluyen Captura de cambios de datos con una API de API Manager o un extremo HTTP y Configurar mensajes salientes con una API de API Manager. (Estos patrones utilizan Design Studio como ejemplo, pero los mismos conceptos se pueden aplicar en Integration 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.
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.