WS502 - Consultar Protocolo de Exportação

Objetivo

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

Descrição do método

Método	getExportProtocolStatus
WSDL	https://soap.comprovei.com.br/exportQueue/index.php?wsdl

Importante

1. 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.
2. 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.

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 transporte (Basic Authentication);
• Solicite o user / password ao administrador da conta.

Exemplo cabeçalho HTTP com a autenticação

POST https://soap.comprovei.com.br/exportQueue/index.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#getExportProtocolStatus"
Authorization: Basic BASE64(user:password)
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Request

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

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

Exemplo de Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:getExportProtocolStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <protocolo xsi:type="xsd:string">20170823599de095e8249</protocolo>
      </urn:getExportProtocolStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG	Tipo	Descrição
status	string	Mensagem de sucesso ou de erro para o protocolo informado.
protocolo	string	Protocolo informado na requisição.
metodo	string	Método requisitado na geração da exportação.
dataCriacao	string	Data e hora da requisição da exportação.
dataConclusao	string	Data e hora que a exportação foi concluída.
processado	string	Sim ou Não indicando que a exportação já foi processada.
resultado	string	Mensagem de sucesso ou erro da exportação.
url	string	URL para fazer o download do arquivo gerado na exportação, em caso de sucesso e existência de dados (Válida por 1 dia).

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:getExportProtocolStatusResponse>
         <status xsi:type="xsd:string">Protocolo encontrado.</status>
         <protocolo xsi:type="xsd:string">20170823599de095e8249</protocolo>
         <metodo xsi:type="xsd:string">downloadDocumentsHistory</metodo>
         <dataCriacao xsi:type="xsd:string">23/08/2017 17:07:49</dataCriacao>
         <dataConclusao xsi:type="xsd:string">23/08/2017 17:07:57</dataConclusao>
         <processado xsi:type="xsd:string">Sim</processado>
         <resultado xsi:type="xsd:string">Exportação realizado com sucesso!</resultado>
         <url><![CDATA[https://s3.amazonaws.com/comprovei/exports/2017/08/23/48/downloadDocumentsHistory/20170823599de095e8249.xml?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=FQoDYXdzEPX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDGbAV8IxGfdaFF4E9CKcA4QZMbeZAq5ej0W3NhqRuMoxIpm8aiUVxZSgSDBRBp5nXh%2F0u02oZiKIB63ahTiJBFtErzSHP9%2FPr8nqyfVDC3rpXAzuHjWp0m%2FTxTqWI1DmcGaoq%2FtzmRYpufRdKGtGmroa0Isig6kUVnWQMT2sXjP3%2F41dyEvKfnVQG3kaccIQdlPJrxpCGhI1HMjSPSTb6QRwwbZ6qNw%2Bm6frPZf7GKyhKMlRlLVkA472t6aqgNJw8SJsHORN9xsqAeS%2Bw7hh88xAcHhbd%2BvZnoq2uhwgJ%2FTRLf2TesD8Oq0Sd3Y9PW4rA3KWftCrQv5jLVmDG7BKa8ge2llCEaSPSca6ScL3O%2B3Ka%2FyH%2FfwgcI9rpOXWk3EfP17ha1QtytmdfLCpf5D9b5bwCC7KnsPQ0sa%2FM7Eeo9qgCRd93F7grpCfQsbLOzQj3mZER75m1XY%2FCb33FrgFTb%2BDrJTODJHmRdwyTGhz0dnCSrHS0G6a%2F4VDX%2BmhvfEu3XOO8fmkzv8NcpXhVKSKbijqUcqlHXwwsBw%2FqNb5Xfw%2FboqgNfkxac%2FOr8Mo8rn3zAU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAITWLC2U6RG74UOJQ%2F20170823%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170823T202156Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Signature=f9a397832670f7a4ae07d6390257acbd47a27285effb3cacfa745b573a2c8262]]></url>
      </ns1:getExportProtocolStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>