Llamar a APIs SOAP usando cURLs (Con imagen)

La frase "SOAP cURLs" comprende dos tecnologías populares de las que puede que hayas oído hablar antes. Antes que nada, este artículo analiza las tecnologías y sus capacidades.

💡

Apidog, una plataforma de desarrollo API de diseño primero, proporciona a sus usuarios numerosas modificaciones y especificaciones para todo el ciclo de vida de la API.

Si necesitas una plataforma API para construir, simular, depurar o documentar APIs, Apidog es una opción óptima. Todo lo que tienes que hacer es hacer clic en el botón de abajo. 👇 👇 👇

Terminologías básicas sobre SOAP y cURLs

Los términos "SOAP" y "cURL" se refieren cada uno a una tecnología única.

SOAP: SOAP (Protocolo Simple de Acceso a Objetos) es un protocolo de mensajería utilizado principalmente para intercambiar información estructurada entre dos aplicaciones o sistemas.

Desempeña un papel importante en la industria de los servicios web debido a su capacidad para facilitar el intercambio de datos y la comunicación entre diferentes componentes de software.

SOAP es un protocolo altamente estructurado que utiliza el formato XML, utilizado principalmente para aplicaciones empresariales o sistemas heredados. Dicho esto, es posible que hayas observado que otros protocolos se están volviendo más populares, como el muy discutido estilo arquitectónico REST.

Los servicios web SOAP también suelen venir en forma de archivos WSDL.
cURL: cURL significa "Cliente para URL". cURL es un software gratuito de código abierto que proporciona dos funcionalidades principales, una herramienta de línea de comandos curl y una biblioteca libcurl.

La herramienta de línea de comandos curl permite la transferencia de datos mediante el uso de varios protocolos de red como HTTP, HTTPS y muchos otros tipos directamente desde tu terminal. Hay muchos usos de curl. Por nombrar algunos, puedes descargar archivos, enviar datos y recuperar el contenido de una página web o la respuesta de un servidor.

Por otro lado, la biblioteca libcurl actúa como la funcionalidad central para las transferencias de datos. libcrul se puede integrar en varios lenguajes de programación populares, como C, C++, Python y PHP. Con libcrul, los desarrolladores pueden aprovechar el rendimiento de cURL con aplicaciones para tareas como la automatización de descargas y cargas de archivos, así como la creación de herramientas o aplicaciones personalizadas para interactuar con servicios web.

Cuando los términos se combinan, "SOAP cURLs" se refiere al uso de las funcionalidades de cURL para interactuar específicamente con servicios web basados en SOAP.

Desglose de cómo funcionan los SOAP cURLs

1. Define el mensaje SOAP:

En primer lugar, se requiere un mensaje de solicitud SOAP específico. Esto implica determinar la operación que deseas llamar en el servicio web y los datos que deseas enviar, todo en formato XML.
Puedes encontrar varias herramientas y recursos disponibles para ayudarte a definir el mensaje SOAP, como el archivo WSDL (Lenguaje de Descripción de Servicios Web) proporcionado por el servicio web o herramientas en línea para generar mensajes SOAP.

2. Construye el comando cURL:

A continuación, construye un comando cURL que especifique los detalles de la solicitud HTTP que transporta el mensaje SOAP. Esto implica el uso de varias opciones de cURL para definir:
URL: La dirección del punto final del servicio web al que deseas llegar.
Método: El método HTTP normalmente se establece en "POST", ya que los mensajes SOAP generalmente se envían utilizando el método POST.
Encabezados: Se requieren encabezados específicos para la comunicación SOAP, como "Content-Type: text/xml; charset=utf-8" para indicar el formato del mensaje y la codificación de caracteres.
Datos: El contenido real del mensaje SOAP se incluirá en el cuerpo de la solicitud utilizando la opción "-d" con la cadena del mensaje o un archivo que contenga el mensaje.

3. Envío de la solicitud y recepción de una respuesta:

Una vez que tengas el comando cURL completo, puedes ejecutarlo en tu terminal. Esto enviará la solicitud HTTP elaborada que contiene el mensaje SOAP al servicio web.
El servicio web procesará la solicitud y devolverá una respuesta, normalmente en formato XML.

4. Procesamiento adicional de la respuesta:

Puedes analizar la respuesta XML para extraer la información relevante devuelta por el servicio web. Esto podría implicar el uso de herramientas o bibliotecas dependiendo del lenguaje de programación utilizado.

Cómo llamar a la API SOAP usando cURL

Paso 1: Primero, deberás preparar tu mensaje SOAP. En caso de que esta sea la primera vez que creas un mensaje SOAP, puedes consultar el ejemplo de código a continuación; sin embargo, deberás modificarlo para asegurarte de que satisfaga tus necesidades.

Mensaje SOAP de ejemplo:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.example.com/webservice">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getGreeting>
         <ws:name>John Doe</ws:name>
      </ws:getGreeting>
   </soapenv:Body>
</soapenv:Envelope>

¿Puedes adivinar qué está solicitando el mensaje del servicio web?

Paso 2: Prepara tu comando cURL en tu terminal. Similar al paso anterior, puedes echar un vistazo al ejemplo de código.

Comando cURL de ejemplo:

curl -X POST \
-H "Content-Type: text/xml; charset=utf-8" \
-H "SOAPAction: http://www.example.com/webservice/getGreeting" \
-d @soap_request.xml "https://dummy.webservice.com/path/to/service"

Explicación del comando cURL:

-X POST: Especifica el método de solicitud HTTP como POST.
-H "Content-Type: text/xml; charset=utf-8" establece el encabezado content-type indicando datos XML con codificación UTF-8.
-H "SOAPAction: http://www.example.com/webservice/getGreeting" establece el encabezado SOAPAction especificando la operación objetivo.
-d @soap_request.xml lee el contenido del mensaje SOAP de un archivo llamado "soap_request.xml".
"https://dummy.webservice.com/path/to/service" se reemplaza con la URL real del punto final del servicio web.

Aplicaciones de la vida real de los SOAP cURLs

1. Integración de sistemas heredados: SOAP se utilizaba a menudo en aplicaciones empresariales más antiguas. Si necesitas interactuar con tales sistemas heredados que no se han migrado a protocolos más nuevos, cURL puede proporcionar una forma de crear y enviar manualmente solicitudes SOAP para el intercambio de datos.

2. Pruebas y depuración de servicios web SOAP: Los desarrolladores pueden usar cURL para enviar directamente solicitudes SOAP específicas y analizar las respuestas para solucionar problemas con los servicios web SOAP. Esto permite un control granular sobre la solicitud y ayuda a aislar posibles problemas.

3. Scripts personalizados y automatización: cURL se puede integrar en scripts y programas para automatizar tareas que involucran la comunicación SOAP. Esto podría ser útil para escenarios como la obtención periódica de datos de un servicio SOAP o la activación de acciones específicas basadas en los mensajes SOAP recibidos.

Apidog - Facilita las pruebas SOAP

Apidog es una plataforma de desarrollo de API que proporciona numerosas funcionalidades para personalizar las APIs a tu gusto. Ya sea que estés planeando crear una nueva API desde cero o importar una API personal en la que has estado trabajando durante algún tiempo, Apidog admite cualquiera de las dos opciones.

api design apidog test build — Funciones de Apidog que los usuarios pueden disfrutar

button

Apidog admite la importación de archivos WSDL para que puedas ver los servicios web basados en SOAP. Por otro lado, también puedes generar comandos cURL utilizando la generación de código de lenguaje cliente de Apidog, ¡para que no tengas que adivinar si estás en lo correcto o no!

Importación de archivos WSDL para ver servicios web basados en SOAP en Apidog

import wsdl file apidog — Importación de un archivo WSDL en Apidog

En primer lugar, presiona el botón Settings que se encuentra en el lado izquierdo de la barra de herramientas vertical. Luego, localiza Import Data en la sección Data Management. Por último, elige WSDL para importar archivos WSDL a Apidog.

Edición de archivos WSDL en Apidog

edit wsdl file apidog — Edición de un archivo WSDL con Apidog

Si el archivo WSDL se ha importado correctamente, encontrarás tu archivo WSDL a la izquierda, como se muestra en la imagen señalada por la flecha 1. A continuación, puedes hacer clic en las flechas numeradas para empezar a editar.

Una vez que hayas importado y depurado tu archivo WSDL, puedes empezar a probarlo en Apidog para detectar más errores. Si aún no estás seguro de si tu archivo WSDL es correcto o no, consulta ejemplos de archivos WSDL para obtener más detalles.

Importación de cURL a Apidog

Apidog admite la importación de códigos de línea de comandos cURL para aquellos que lo tengan listo.

start curl import apidog — Inicialización de la importación de cURL en Apidog

En la sección APIs, busca un botón púrpura + que se encuentra alrededor de la esquina superior izquierda de la ventana de Apidog. A continuación, selecciona Import cURL. Si no encuentras el botón mencionado, puedes utilizar el atajo, Ctrl + I.

paste curl command apidog — Pega tu comando cURL en el campo vacío

Aquí, puedes pegar tu comando cURL. Una vez que lo hayas hecho, presiona Enter en tu teclado o el botón OK para ver tu comando cURL.

curl code body edit apidog — Decide si necesitas modificar algo más

Si tiene éxito, puedes ver el comando cURL como parte del cuerpo JSON, como se muestra en la imagen de arriba. Aquí, puedes hacer ajustes o cambios, donde y cuando sea necesario.

Generación de código de comando cURL usando Apidog

curl comannd code generation apidog — Generación de código de línea de comandos cURL

Para comenzar la generación de código cURL, localiza y presiona el botón </> que se encuentra en la esquina superior derecha de la ventana de Apidog. A continuación, selecciona Generate Client Code.

curl code generate apidog — Selecciona el código de línea de comandos cURL usando Apidog

Una ventana emergente te pedirá que selecciones qué código de cliente generar. Aquí, selecciona Shell y cURL. Una vez que lo hayas hecho, puedes copiar el código y pegarlo en tu terminal. Sin embargo, asegúrate de modificarlo para que se ajuste a tus necesidades.

Conclusión

SOAP cURLs son dos tecnologías que pueden funcionar de la mano, donde los comandos cURL se pueden utilizar para la comunicación de servicios web basados en SOAP. Sin embargo, ten en cuenta que su uso está disminuyendo debido a estilos arquitectónicos más populares como REST.

Apidog es una plataforma de desarrollo de API todo en uno que promueve un desarrollo de diseño primero para las APIs. Con Apidog, puedes modificar y diseñar fácilmente las APIs visualmente gracias a su interfaz de usuario simple e intuitiva. Además, es una opción sólida para cualquier desarrollador que esté interesado en probar una nueva plataforma, ya que Apidog admite varias importaciones de tipos de archivos, con Postman, WSDL y muchos más.