SOAP Web Services

Consome serviços SOAP a partir de um WSDL

Carregar WSDL

soap.load_wsdl

Carrega definição do serviço SOAP

Como usar

Lê o WSDL de um serviço SOAP (por URL ou arquivo) e guarda o serviço na variável, pronto para chamar operações. Informe usuário e senha se o WSDL exigir autenticação HTTP, e o nome do serviço/porta quando houver mais de um.

Exemplo: Carregue https://nfe.fazenda.sp.gov.br/ws/consulta.asmx?WSDL em {soap}.

Campos

Campo	Tipo	Padrão	Detalhes
WSDL (URL ou arquivo) *	Texto		Ex.: `https://servidor/servico?wsdl`
Salvar o serviço na variável *	Variável de saída	`soap`

+ Avançado (6)

Campo	Tipo	Padrão
Usuário (HTTP Basic)	Texto
Senha (cofre)	Credencial do cofre
Tempo limite (0 = sem limite)	Número	`60 s`
Verificar o certificado SSL	Sim/Não	`Sim`
Nome do serviço (se houver vários)	Texto
Nome da porta	Texto

Resultado: guardado na variável soap (Objeto).

Chamar Operação

soap.call_operation

Invoca uma operação do WSDL

Como usar

Chama uma operação do serviço com os argumentos (nome → valor, ou um dicionário de uma variável) e guarda a resposta já convertida em dicionário, com números como números.

Exemplo: Chame ConsultarCEP com cep = {cep} e use {response.logradouro}.

Campos

Campo	Tipo	Padrão	Detalhes
Serviço SOAP *	Variável	`soap`
Operação *	Texto		Ex.: `ConsultarCliente`
Argumentos (nome → valor)	Pares chave e valor
Salvar resultado na variável *	Variável de saída	`response`	A resposta como dicionário: {resposta.Campo}

+ Avançado (2)

Campo	Tipo	Padrão	Detalhes
Argumentos de uma variável com dicionário	Texto		Para estruturas aninhadas; somado aos argumentos acimaEx.: `{dados}`
Manter o objeto original do zeep	Sim/Não	`Não`

Resultado: guardado na variável response (Qualquer).

Definir WS-Security

soap.set_ws_security

Configura autenticação WS-Security

Como usar

Adiciona autenticação WS-Security (UsernameToken) às chamadas do serviço, com senha do cofre, em texto ou digest, e Timestamp opcional.

Exemplo: Configure WS-Security em {soap} com o usuário do convênio e a senha CONVENIO_SENHA em digest.

Campos

Campo	Tipo	Padrão
Serviço SOAP *	Variável	`soap`
Usuário *	Texto
Senha (cofre) *	Credencial do cofre
Senha em digest (PasswordDigest)	Sim/Não	`Não`

+ Avançado (1)

Campo	Tipo	Padrão	Detalhes
Incluir Timestamp	Sim/Não	`Sim`

Analisar Resposta

soap.parse_response

Parseia resposta SOAP como dicionário

Como usar

Converte uma resposta SOAP (objeto ou XML) em dicionário e, com um caminho como Retorno.Itens, pega só a parte que interessa.

Exemplo: Analise {response} no caminho Resultado.Notas para obter a lista de notas fiscais.

Campos

Campo	Tipo	Padrão	Detalhes
Resposta (objeto ou XML) *	Texto		Ex.: `{resposta}`
Caminho (vazio = tudo)	Texto		Ex.: `Cliente.Enderecos.0.Cidade`
Salvar resultado na variável *	Variável de saída	`value`

Resultado: guardado na variável value (Qualquer).