Cómo consumir una API SOAP con el componente "Soap api V2" en wolkvox Studio
Table of Contents
Introducción
El componente “Soap api V2” de wolkvox Studio te permite consumir servicios SOAP directamente dentro de tus flujos, para consultar, actualizar, crear o eliminar información en sistemas externos sin salir de la lógica de enrutamiento.
SOAP (Simple Object Access Protocol) es un protocolo para intercambiar información entre sistemas usando mensajes estructurados en XML. A diferencia de muchas APIs “REST” (que suelen usar JSON), en SOAP normalmente envías una “envoltura” (envelope) en XML con el detalle de la operación que quieres ejecutar, y el servidor responde también en XML.
Este componente está en el grupo Comunicaciones y está disponible para Voice, Interaction, Chat, CRM + Webhook y Agent Scripting.
Configuración
- Haz doble clic sobre el componente para abrir su panel de configuración (lado derecho).
- Configura sus campos:
- Configura la URL del servicio: En “URL”, pega la dirección del endpoint que vas a consumir.
- Si el servicio requiere parámetros en la URL (query params), inclúyelos allí.
- Selecciona el método de consumo: En “Método” elige uno de los disponibles según lo que necesites:
- GET: obtener información de un recurso.
- POST: enviar información al servidor (crear / enviar datos).
- PUT: actualizar información de un recurso existente (sobrescribe con lo enviado).
- ELIMINAR (DELETE): eliminar un recurso.
- Agrega los headers requeridos:
- En “Headers”, escribe cada encabezado que el servicio exija (por ejemplo, Content-Type, tokens, credenciales, etc.).
- Haz clic en “Agregar” para incluirlo.
- Verifica que queden listados en la tabla “Cabeceras”.
- Tip típico en SOAP: muchos servicios trabajan con Content-Type: text/xml o application/soap+xml (depende del servicio). Usa exactamente el que te indique el proveedor del endpoint.
- Escribe el cuerpo (XML SOAP) si aplica: En “Cuerpo”, pega el contenido que el servicio requiera.
- Para SOAP, usualmente aquí va el XML con el Envelope de la operación (por ejemplo: <soapenv:Envelope>...</soapenv:Envelope>).
- Si el método es GET y el servicio no requiere body, este campo puede quedarse vacío (depende del endpoint).
- Define dónde guardar la respuesta:
- En “Resultado”, escribe la variable donde quieres almacenar la respuesta del consumo (por ejemplo: $respuesta_soap).
- Ten presentes las variables por defecto. El componente también registra automáticamente:
- $soap_api_time: tiempo de ejecución del consumo.
- $soap_api_code: código de respuesta (útil para validar éxito/error y enrutar el flujo).
- Guarda la configuración: Haz clic en “Guardar” para aplicar los cambios.
- Configura la URL del servicio: En “URL”, pega la dirección del endpoint que vas a consumir.
