Skip to Content
IntegraçõesHTTP e SOAP

HTTP e SOAP

Recebimento REST

POST /api/{sigla-da-interface}/{sigla-da-definicao}

Aceita application/json, application/xml e text/plain. A autenticação usa o API Token da aplicação, em qualquer um dos formatos:

x-api-token: <token>
Authorization: Bearer <token>
Authorization: Basic <base64 com o token na posição da senha>

Resposta:

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

Se a Definição for SINCRONA, a resposta só volta depois da entrega no destino — e carrega o resultado dela.

Resposta da Entrega síncrona

Numa Entrega SINCRONA, return_message é sempre um texto de situação — e o que o destino respondeu vem à parte, em 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 volta como JSON; XML ou texto voltam como string, sem invólucro — o mesmo formato do collected_payload da Coleta.
  • Destino que respondeu vazio (um HTTP 204, por exemplo): o campo não vem.
  • Com erro (hasError: true), return_message traz a descrição do Erro de Negócio ou a falha de entrega, e response_payload traz o corpo que o destino devolveu, se devolveu algum.
  • No SOAP, o mesmo conteúdo vai no elemento opcional <response_payload>, em texto.

Até setembro de 2026 a resposta do destino vinha crua dentro de return_message.

Decodificação de entrada

Quando o cliente não consegue enviar o formato final, a Definição pode decodificar antes de processar: BASE64, XML_UNESCAPED, URL_ENCODED, HEX, CHARSET_LATIN1, HTML_ENTITIES.

Recebimento SOAP

Definições com Ativar WebService (WSDL) ligado ganham endpoint SOAP com WSDL gerado dinamicamente:

GET  /api/ws/{interface}/{definicao}?wsdl
POST /api/ws/{interface}/{definicao}

A autenticação pode vir por WS-Security UsernameToken no envelope, em vez do header.

Uma Coleta com Parâmetros de Entrada tem a mesma chave, e com ela a API dinâmica de Coleta passa a responder também em SOAP, na operação ExecutarColeta:

GET  /api/ws/collect/{interface}/{coleta}?wsdl
POST /api/ws/collect/{interface}/{coleta}

Cada Parâmetro de Entrada vira um elemento do envelope, e o WS-Security dessa operação aceita também o login e a senha de uma Credencial de Entrada. Ver API dinâmica de Coleta.

Coleta HTTP

Tipos HTTP_GET e HTTP_POST: o CMS chama um endpoint externo em intervalo agendado e encaminha a resposta para as interfaces de destino configuradas. Com Parâmetros de Entrada, a Coleta passa a rodar sob demanda — por quem chama a API dinâmica de Coleta, por um Gatilho ou por um agente de IA —, e os parâmetros entram na URL e no corpo da chamada.

Configuração típica:

  • URL e método
  • Credencial para autenticação (basic, bearer, header)
  • Transformador para converter a resposta no formato do destino
  • Agendamento (cron ou intervalo) em Agendadores

Para consumir uma API paginada ou que exige montar a URL a partir de outro dado, resolva a lógica no Transformador ou encadeie coletas — o CMS não faz paginação automática.

Entrega HTTP

Tipos HTTP_POST, HTTP_PUT, HTTP_PATCH, HTTP_DELETE, com timeout, tentativas e backoff próprios por Definição. A resposta do destino é gravada no histórico da mensagem e avaliada pelas regras de Erro de Negócio.

Entrega SOAP

Tipo HTTP_SOAP: envia o envelope montado ao endpoint do destino, com credencial WS-Security quando configurada.

Visão geralMQTT