SOAP V3

Descubra mais sobre o componente SOAP V3 e saiba como utilizá-lo na Digibee Integration Platform.

O componente SOAP V3 utiliza templates do Apache Freemaker para gerar a mensagem de request que converte o retorno do SOAP em JSON, tentando ao máximo não atrapalhar a conversão.

Parâmetros

Dê uma olhada nos parâmetros de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro

Descrição

Valor padrão

Tipo de dado

URL

URL a ser chamada - pode conter os parâmetros seguindo o padrão {:param1}, que serão substituídos pela propriedade correspondente da mensagem de entrada.

https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente

String

Account

Conta a ser utilizada pelo componente. Contas suportadas: basic, certificate-chain e ntlm Leia a documentação sobre Contas (Accounts) para saber mais sobre os tipos de contas disponíveis.

N/A

String

Custom Account #1

Conta adicional a ser utilizada pelo componente por meio de Double Braces {{ account.custom-1.value }}. Leia o artigo Funções Double Braces para saber mas sobre o tema.

N/A

String

Custom Account #2

Conta adicional a ser utilizada pelo componente por meio de Double Braces {{ account.custom-2.value }}. Leia o artigo Funções Double Braces para saber mas sobre o tema.

N/A

String

Send the Request Body from a File

Se habilitada, a opção considera o conteúdo a ser enviado na chamada através de um arquivo; do contrário, será considerado o que for especificado em Template (XML).

False

Booleano

Request Body File Name (DB)

Informa o nome do arquivo a ser enviado na chamada SOAP, se a opção Send the Request Body from a File estiver ativada.

N/A

String

Template (XML) (DB)

Template Apache FreeMarker para que a mensagem SOAP seja enviada na solicitação. Este campo não estará disponível se a opção Send the Request Body from a File estiver habilitada.

N/A

String

Headers

Headers da chamada.

N/A

Key-value Pairs

Query Params

Query parameters da chamada.

N/A

Key-value Pairs

Attachments (MTOM)

Adiciona ou remove opções para configurar arquivos ou conteúdos binários a serem enviados na requisição utilizando a tecnologia MTOM. Este parâmetro não estará disponível se a opção Send the Request Body from a File estiver habilitada.

N/A

Opções de Attachments

Is Binary

Se ativada, o conector deverá receber o conteúdo binário e o ID do arquivo a ser enviado na requisição, do contrário, deve ser informado o nome do arquivo. Disponível apenas quando o parâmetro Attachments (MTOM) estiver adicionado.

False

Booleano

File Name

Quando a opção Is Binary estiver desativada, este campo informa o nome do arquivo a ser enviado junto do XML configurado em Template (XML). Disponível apenas quando o parâmetro Attachments (MTOM) estiver adicionado.

N/A

String

File ID

Quando a opção Is Binary estiver ativada, este campo informa o ID do arquivo a ser enviado junto do XML configurado em Template (XML). Disponível apenas quando o parâmetro Attachments (MTOM) estiver adicionado.

N/A

String

Base64 Content

Quando a opção Is Binary estiver ativada, este campo informa o conteúdo em Base64 a ser enviado junto do XML configurado em Template (XML). Disponível apenas quando o parâmetro Attachments (MTOM) estiver adicionado.

N/A

String

WS-Security

Configura a camada de segurança da requisição utilizando a tecnologia WS-Security. Este parâmetro não estará disponível caso a opção Send the Request Body from a File esteja ativada.

N/A

Opções de WS-Security

Type

Tipo de propriedade a ser inserida na camada de segurança no XML da requisição. Atualmente o conector suporta apenas os tipos Timestamp e UsernameToken. Disponível apenas quando o parâmetro WS-Security estiver adicionado.

N/A

String

Time to live

Tempo em segundos a ser utilizado para gerar a data de criação e expiração. Disponível apenas se Timestamp estiver selecionado em Type.

Inteiro

Millisecond precision

Define se a data de criação e expiração devem incluir precisão em milissegundos. Disponível apenas se Timestamp estiver selecionado em Type.

False

Booleano

Username

Nome de usuário da conta a ser utilizada. Disponível apenas se UsernameToken estiver selecionado em Type.

N/A

String

Password

Senha da conta a ser utilizada. Disponível apenas se UsernameToken estiver selecionado em Type.

N/A

String

Password Type

Tipo de senha a ser utilizada. Disponível apenas se UsernameToken estiver selecionado em Type.

N/A

String

Add Nonce

Se ativa, inclui um Nonce. Disponível apenas se UsernameToken estiver selecionado em Type.

False

Booleano

Add Created

Se ativa, inclui a data de criação. Disponível apenas se UsernameToken estiver selecionado em Type.

False

Booleano

Connection Timeout

Tempo de expiração da conexão (em milissegundos).

30000

Inteiro

Reading Timeout

Tempo máximo para leitura (em milissegundos).

30000

Inteiro

Stop On Client Error

Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.

False

Booleano

Stop On Server Error

Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.

False

Booleano

All Values As String

Se ativada, a opção vai retornar todos os valores dentro das propriedades XML em string.

False

Booleano

Is Multipart Response

Se ativada, será esperada uma resposta Multipart da chamada, e será exibida uma lista contendo cada Part retornada.

False

Booleano

With Namespace

Se ativada, a opção mantém os namespaces no retorno do XML.

True

Booleano

Override Response Charset

Quando ativada, a opção irá sobrescrever o charset retornado do endpoint para o charset especificado em Response Charset. Quando desabilitada, ela respeitará o retorno do charset no campo Content-Type (dentro do parâmetro Headers). Caso não retorne nenhum charset no Content-Type, o padrão utilizado será UTF-8.

True

Booleano

Response Charset

Determina o uso do charset especificado neste campo. Disponível somente quando a opção Override Response Charset estiver ativa. Padrão: UTF-8.

UTF-8

String

Advanced Settings

Se ativada, os seguintes parâmetros estarão disponíveis

False

Booleano

Allow Insecure

Quando ativada, a opção permite que chamadas não seguras a endpoints HTTPS sejam feitas.

False

Booleano

Raw Mode

Se ativada, a opção recebe ou passa um payload sem ser JSON.

False

Booleano

Save As Local File

Quando ativada, a opção salva o retorno como um arquivo no diretório local do pipeline. O arquivo será salvo apenas quando houver sucesso na chamada SOAP, ou seja, quando o http status code da resposta estiver entre 200 e 399.

False

Booleano

Response File Name (DB)

Nome do arquivo ou caminho completo do arquivo (ex.: tmp/processed/file.txt) onde será salva a resposta da chamada SOAP. Double Braces são suportados. Este campo é mostrado apenas se Save As Local File estiver ativado.

N/A

String

Enable Retries

Quando ativada, a opção permite que sejam feitas novas tentativas.

False

Booleano

Maximum Number Of Retries Before Giving Up

Número máximo de tentativas antes de desistir da chamada. Este campo é mostrado apenas se Enable Retries estiver ativado.

Inteiro

Time To Wait Before Each Retry

Tempo máximo entre tentativas (em milissegundos). Este campo é mostrado apenas se Enable Retries estiver ativado.

Inteiro

Use Dynamic Account

Quando a opção estiver ativada, o componente irá usar a conta dinamicamente. Quando estiver desativada, a conta será usada estaticamente.

False

Booleano

Account Name

Nome da conta a ser definida. O nome da conta deve ser gerado dinamicamente através do componente Store Account.

N/A

String

Scoped

Quando a opção estiver ativada, a conta armazenada é isolada para outro sub-processo. Nesse caso, os sub-processos verão sua própria versão dos dados da conta armazenada. Essa opção não é suportada para contas usadas em headers ou body. Para saber mais sobre a funcionalidade Scoped, leia a documentação de Suporte a credenciais dinâmicas.

False

Booleano

Atualmente, os parâmetros Use Dynamic Account, Account Name e Scoped podem ser usados apenas no Pipeline Engine v2 e estão disponíveis em fase Beta Restrito. Para saber mais, leia o artigo Progama Beta.

Informações adicionais sobre parâmetros

Add Created

As propriedades Username e Password devem ser configuradas usando os campos Custom Account #1 ou Custom Account #2 (conta do tipo BASIC).

Usando a tecnologia MTOM

para utilizar a tecnologia MTOM, é necessário que o arquivo ou conteúdo em Base64 seja referenciado diretamente no XML da requisição, sendo substituído pelo valor configurado em File Name ou File ID, dentro da tag padrão <inc:Include> junto do namespace obrigatório xmlns:inc="http://www.w3.org/2004/08/xop/include" , referentes ao MTOM.

Lembre-se que File Name e File ID ficam disponíveis apenas quando Is Binary estiver ativado em Attachments (MTOM).

Exemplo ao configurar o campo File Name/File ID com o valor "myImage.png":

XML original:

<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
        ...
        <file>iVBORw0KGgoAAAAN... (Base64 content)</file>
        ...
   </soapenv:Body>
</soapenv:Envelope>

XML ativando MTOM:

<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
        ...
        <file><inc:Include href="cid:myImage.png" xmlns:inc="http://www.w3.org/2004/08/xop/include"/></file>
        ...
   </soapenv:Body>
</soapenv:Envelope>

Sobre o template variável

O nome da variável também pode conter sinal de menos (-), ponto (.) e dois pontos (:) em qualquer posição, desde que eles sejam acompanhados de uma barra invertida (\) logo antes. Do contrário, os sinais podem ser interpretados como operadores.

Sobre substituição de números

<#assign x=42>

  ${x}

  ${x?string}  <#-- the same as ${x} -->

  ${x?string.number}

  ${x?string.currency}

  ${x?string.percent}

  ${x?string.computer}

Resultado

Formato de número

<#setting number_format="0.####">

Para verificar se o campo não é nulo:

<#if varTest??>${varTest}</#if>

AnteriorREST V1 (Descontinuado)PróximoSOAP V2

Atualizado há 7 meses