Pular para conteúdo

WS114 - Receber Documentos da Comprovei

Objetivo

Esta integração tem por objetivo receber os documentos com status DISPONÍVEL da Comprovei©.

Documentos disponíveis são aqueles que ainda não foram atribuídos a nenhuma rota. Portanto, quando este método for requisitado, todos os documentos com status DISPONÍVEL, respeitando a quantidade informada na requisição, serão disponibilizados em um único arquivo XML para consulta.

Descrição do método
Método downloadDocuments
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;

Importante

O usuário deste Web Service deve armazenar o protocolo gerado na resposta. Chamados de suporte referentes a esta integração irão necessitar deste protocolo.

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#downloadDocuments"
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
qtdDocumentos integer Quantidade máxima de documentos que serão retornadas pela consulta.

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:downloadDocuments soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <qtdDocumentos xsi:type="xsd:string">1</qtdDocumentos>
      </urn:downloadDocuments>
   </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 a chamada do método.
protocolo string Protocolo para consultar a evolução do pedido de exportação.

Protocolo

Quando um pedido de exportação é criado no nosso sistema, um protocolo é gerado para que este processo seja acompanhado. Isso pode ser feito utilizado o método WS502.

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:downloadDocumentsResponse>
         <status xsi:type="xsd:string">Exportação adicionada a fila com sucesso. Acompanhe o processamento utilizando o protocolo fornecido!</status>
         <protocolo xsi:type="xsd:string">20170823599de095e8249</protocolo>
      </ns1:downloadDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

O que é gerado nesta exportação

Utilizando o protocolo gerado no método WS502, o usuário receberá uma URL para acessar o arquivo XML contendo todos os documentos disponíveis no sistema. Este XML possui o mesmo formato utilizado para a importação de documentos na Comprovei.

Para saber mais sobre este arquivo, acesse a documentação do WS013. Lá você saberá mais sobre cada TAG que compõem este XML, além de ter acesso ao seu XSD.