WS501 - Consultar Protocolo de Importação

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
15/04/2021	15/04/2021	Criação da v3

Objetivo

Esta integração tem por objetivo disponibilizar a consulta do andamento das importações utilizando os protocolos recebidos.

Descrição do método


`Método`	getImportProtocolStatus
`Versão`	3
`WSDL principal`	https://soap.comprovei.com.br/importQueue/v3/index.php?wsdl
`WSDL de contingência`	https://soapcontingencia.comprovei.com.br/importQueue/v3/index.php?wsdl

Importante

A conexão ao nosso serviço deve ser feito ao nosso servidor principal, porém sugerimos fortemente que também seja disponibilizada uma conexão ao nosso servidor de contingência, como garantia de disponibilidade dos nossos serviços. O servidor de contingência só é ligado em situações de indisponibilidade do nosso servidor principal. Tornar parametrizável a url de conexão também é uma boa prática;
Nossas conexões são seguras utilizando o protocolo SSL. Por questão de segurança nossos certificados são alterados constantemente e sem aviso prévio. Portanto é recomendável que não desenvolvam as integrações baseadas em um certificado fixo.
Constantemente (e sem aviso prévio) adicionamos novos campos e estruturas tanto nas requisições quanto nas respostas dos nossos webservices. Quem for utilizar nossos webservices deve implementar de tal maneira que os programas que consomem estes webservices não deixem de funcionar quando houver as alterações de campos mencionadas.

Versão

Você está acessando a versão 3 do nosso sistema de integração. Caso deseje consultar a versão anterior, clique aqui.

Características

As chamadas serão realizadas via SOAP sobre HTTPS;
A origem do chamado do Web Service será o sistema do cliente;

Autenticação

As chamadas terão autenticação a nível de mensagem (SOAP Header);
Solicite o usuario / senha ao administrador da conta.

Request

A requisição para o nosso Web Service é composta da seguinte forma:

Dentro da TAG <Credenciais>:

TAG	Tipo	Descrição
`Usuario`	string	Usuario para autenticação.
`Senha`	string	Senha do usuário para autenticação

Body

Dentro da TAG <getImportProtocolStatus>:

TAG	Tipo	Descrição
`protocolo`	string	Protocolo para consultar a evolução do pedido de importação.

Exemplo de Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <Credenciais xmlns="WebServiceComprovei">
            <Usuario>usuario</Usuario>
            <Senha>senha</Senha>
        </Credenciais>
    </Header>
    <Body>
        <getImportProtocolStatus xmlns="WebServiceComprovei:getImportProtocolStatus">
            <protocolo>20170804598506cf87a0d</protocolo>
        </getImportProtocolStatus>
    </Body>
</Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG	Tipo	Descrição
`status`	string	Mensagem de sucesso ou de erro para a chamada do método.
`protocolo`	string	Protocolo informado na requisição.
`metodo`	string	Método requisitado na geração da importação.
`dataCriacao`	string	Data e hora da requisição da importação.
`dataConclusao`	string	Data e hora que a importação foi concluída.
`processado`	string	Sim ou Não indicando que a importação já foi processada.
`resultado`	string	Mensagem de sucesso ou erro da importação.

Exemplo de Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:getImportProtocolStatusResponse>
         <status xsi:type="xsd:string">Protocolo encontrado.</status>
         <protocolo xsi:type="xsd:string">20170804598506cf87a0d</protocolo>
         <metodo xsi:type="xsd:string">uploadRoute</metodo>
         <dataCriacao xsi:type="xsd:string">04/08/2017 20:44:15</dataCriacao>
         <dataConclusao xsi:type="xsd:string">04/08/2017 20:44:34</dataConclusao>
         <processado xsi:type="xsd:string">Sim</processado>
         <resultado xsi:type="xsd:string">Rota importada com sucesso!</resultado>
      </ns1:getImportProtocolStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>