REST to SOAP

Sumário

1. Conceito

Esta funcionalidade, permite disponibilizar uma API REST que redireciona seu conteúdo no formato SOAP.

• Personalize uma autorização de acesso para a API REST;
• Preencha a autenticação para a chamada do WS SOAP destino;
• Cadastre o template do payload para o serviço SOAP;
• Compartilhe o endpoint.

2. Menu de Acesso

• Realize o login na Plataforma do CONNECT;
• Selecione Sobre;
• Clique em REST para SOAP.

3. Funcionalidades

3.1 Listagem de Rest para SOAP

A tela de listagem exibe todos os REST para SOAP do ambiente, permitindo que os usuários visualizem o Nome do Método (equivalente ao endpoint gerado para a chamada da integração), última data de modificação, indicador de integração ativa, parâmetros de URL que podem ser enviados e o método de chamada do endpoint.

Na aba de ações é possível chamar a URL do endpoint, ir para a tela de edição, deletar o registro, exportar (para backups ou migração) ou navegar para a tela de monitoramento da integração.

3.2 Criando um REST para SOAP

Campos disponíveis e suas funcionalidades

• Ativo: Define se o endpoint pode ser chamado;
• Nome do método: Identificador do endpoint;
• Método REST: Método ao qual o endpoint vai responder;
• Tag para Retorno com Sucesso: Tag do Web Service SOAP destino que reporta o sucesso da operação;
• Tag para Retorno com Erro: Tag do Web Service SOAP destino que reporta um erro de operação;
• Parâmetros de URL: Valores que podem ser utilizados para alimentar a consulta dinamicamente com parâmetros de URL;
• Encoding de Retorno: Encoding a ser utilizado nos dados que são enviados ao Web Service destino;
• Fila de integração: Contexto de execução dentro do ambiente, escopo de filas de processamento;
• Campo de XML: Define o XML que vai ser enviado para o Web Service SOAP de destino, pode receber valores dinâmicos dos Parâmetros de URL ou RequestBody recebidos no endpoint.
• Autorização: Define um cabeçalho de Authorization no endpoint que serve como uma chave-de-uso para que o mesmo não seja disponibilizado de forma aberta.
• Autorização-SOAP: Define as configurações do Serviço Web que vai ser responsável por processar o resultado da Query realizada.
• WS URL SOAP: URL para a chamada do Web Service que vai receber os dados da consulta;
• WS Método: Método da requisição para o Web Service;
• Tipo de Autorização do Serviço Web: Nenhum (público), Bearer (código fixo) ou Basic Auth (associado a um registro de Credencial da plataforma);
• WS Token: Token ou Credencial a ser associado ao Tipo de Autorização do Serviço Web.

3.3 Chamando um REST para SOAP

URL para chamada do REST para SOAP pode ser obtido apoós realizar um teste de API, já com os parâmetros de URL indicados (caso tenham sido definidos):

O endpoint gerado pelo CONNECT tem o formato HOST/AMBIENTE/FUNCIONALIDADE/IDENTIFICADORES, para o exemplo:

A URL para chamada do REST para SOAP pode ser obtido realizar um teste de API, já com os parâmetros de URL indicados (caso tenham sido definidos):

O endpoint gerado pelo CONNECT tem o formato HOST/AMBIENTE/FUNCIONALIDADE/IDENTIFICADORES, para o exemplo:

Exemplo de chamada com Autorização

INSERIR JS