Skip to content

WS502 - Consult Export Protocol

Click here to see version history
Update date Service publication date Changes
01/12/2022 01/12/2022 Link validity update

Objective

This integration aims to make export progress available using the protocols received.

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

Important

  1. Our connections are secure using the SSL protocol. For security reasons, our certificates are constantly changed without prior notice. Therefore, it is recommended that you do not develop integrations based on a fixed certificate.
  2. We constantly (and without prior notice) add new fields and structures to both requests and responses from our web services. Anyone who uses our webservices must implement it in such a way that the programs that consume these webservices do not stop working when the mentioned field changes occur.

Version

You are accessing version 2 of our integration system. If you wish to consult the previous version, click here.

Features

  • Calls will be made via SOAP over HTTPS;
  • The origin of the Web Service call will be the client's system;

Authentication

  • Calls will have message-level authentication (SOAP Header);
  • Request the username / password from the account administrator.

Request

The request for our Web Service is composed as follows:

Within the <Credentials> TAG:

TAG Type Description
Usuario string User for authentication.
Senha string User password for authentication

Body

Inside the <getImportProtocolStatus> TAG:

TAG Type Description
protocolo string Protocol for checking the progress of the import request.

Request Example

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

Response

Our Web Service responds to you as follows:

TAG Type Description
status string Success or error message for the informed protocol.
protocolo string Protocol informed in the request.
metodo string Method requested when generating the export.
dataCriacao string Date and time of the export request.
dataConclusao string Date and time the export was completed.
processado string Yes or No indicating that the export has already been processed.
resultado string Export success or error message.
url string URL to download the file generated in the export, in case of success and data existence (Valid for 1 hour).

Response Example

<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>