Skip to Content
IntegracionesHTTP y SOAP

HTTP y SOAP

Recepción REST

POST /api/{sigla-de-la-interfaz}/{sigla-de-la-definicion}

Acepta application/json, application/xml y text/plain. La autenticación usa el API Token de la aplicación, en cualquiera de estos formatos:

x-api-token: <token>
Authorization: Bearer <token>
Authorization: Basic <base64 con el token en la posición de la contraseña>

Respuesta:

{
  "id_message": "uuid-del-mensaje",
  "message_type": "ASYNC",
  "return_message": "Message received and queued",
  "hasError": false
}

Si la Definición es SINCRONA, la respuesta solo vuelve después de la entrega en el destino — y lleva el resultado de esta.

Respuesta de la Entrega síncrona

En una Entrega SINCRONA, return_message es siempre un texto de situación — y lo que respondió el destino viene aparte, en response_payload:

{
  "id_message": "4f055330-1c87-4423-89ee-1513d66bc6f2",
  "message_type": "SYNC",
  "return_message": "Message delivered successfully",
  "hasError": false,
  "response_payload": { "MessageName": "AnyToMES", "id": 101 }
}
  • JSON vuelve como JSON; XML o texto vuelven como string, sin envoltorio — el mismo formato del collected_payload de la Recolección.
  • Destino que respondió vacío (un HTTP 204, por ejemplo): el campo no viene.
  • Con error (hasError: true), return_message trae la descripción del Error de Negocio o la falla de entrega, y response_payload trae el cuerpo que devolvió el destino, si devolvió alguno.
  • En SOAP, el mismo contenido va en el elemento opcional <response_payload>, como texto.

Hasta septiembre de 2026 la respuesta del destino venía cruda dentro de return_message.

Decodificación de entrada

Cuando el cliente no logra enviar el formato final, la Definición puede decodificar antes de procesar: BASE64, XML_UNESCAPED, URL_ENCODED, HEX, CHARSET_LATIN1, HTML_ENTITIES.

Recepción SOAP

Las Definiciones con Activar WebService (WSDL) activado obtienen un endpoint SOAP con WSDL generado dinámicamente:

GET  /api/ws/{interfaz}/{definicion}?wsdl
POST /api/ws/{interfaz}/{definicion}

La autenticación puede venir por WS-Security UsernameToken en el envelope, en lugar del header.

Una Recolección con Parámetros de Entrada tiene la misma opción, y con ella la API dinámica de Recolección pasa a responder también en SOAP, en la operación ExecutarColeta:

GET  /api/ws/collect/{interfaz}/{recoleccion}?wsdl
POST /api/ws/collect/{interfaz}/{recoleccion}

Cada Parámetro de Entrada se vuelve un elemento del envelope, y el WS-Security de esa operación acepta también el login y la contraseña de una Credencial de Entrada. Ver API dinámica de Recolección.

Recolección HTTP

Tipos HTTP_GET y HTTP_POST: el CMS llama a un endpoint externo en un intervalo programado y reenvía la respuesta a las interfaces de destino configuradas. Con Parámetros de Entrada, la Recolección pasa a correr bajo demanda — por quien llama a la API dinámica de Recolección, por un Disparador o por un agente de IA —, y los parámetros entran en la URL y en el cuerpo de la llamada.

Configuración típica:

  • URL y método
  • Credencial para autenticación (basic, bearer, header)
  • Transformador para convertir la respuesta al formato del destino
  • Programación (cron o intervalo) en Programadores

Para consumir una API paginada o que exige armar la URL a partir de otro dato, resuelva la lógica en el Transformador o encadene recolecciones — el CMS no hace paginación automática.

Entrega HTTP

Tipos HTTP_POST, HTTP_PUT, HTTP_PATCH, HTTP_DELETE, con timeout, reintentos y backoff propios por Definición. La respuesta del destino se graba en el historial del mensaje y es evaluada por las reglas de Error de Negocio.

Entrega SOAP

Tipo HTTP_SOAP: envía el envelope armado al endpoint del destino, con credencial WS-Security cuando está configurada.

Visión generalMQTT