Pular para conteúdo

WS116 - Serviço de download de notas dos AWBs

Clique aqui para ver histórico de versões
Data de atualização Data de publicação do serviço Alterações
09/02/2021 15/02/2021 Criação do webservice
18/03/2021 26/03/2021 Correção do serviço de retorno

Objetivo

Esta integração tem por objetivo exportar os AWBs importados no Comprovei. Cada chamada só irá retornar os AWBs que ainda não haviam sido retornados em chamadas anteriores.

Aviso

Esta é uma documentação de um serviço beta que está sujeito a alterações de campos e urls antes de sua publicação definitiva.

Descrição do método
Método downloadDocumentsAWBs
Versão 2
WSDL Principal https://soap.comprovei.com.br/exportQueue/v2/index.php?wsdl
WSDL de Contingência https://soapcontingencia.comprovei.com.br/exportQueue/v2/index.php?wsdl

Importante

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

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.

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

TAG Tipo Descrição
cnpjEmissorNFe string Cnpj do Emissor NF-e - somente dígitos e com zeros à esquerda.
qtdAWBs integer Quantidade máxima de AWbs que serão consultados. * O número máximo será 2000.

Exemplo de Request

<Envelope xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
   <Header>
        <Credenciais xmlns="WebServiceComprovei">
            <Usuario>usuario</Usuario>
            <Senha>senha</Senha>
        </Credenciais>
    </Header>
   <Body>
      <urn:downloadDocumentsAWBs soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <cnpjEmissorNFe xsi:type="xsd:string">01234567890123</cnpjEmissorNFe>
         <qtdAWBs xsi:type="xsd:integer">1000</qtdAWBs>
      </urn:downloadDocumentsAWBs>
   </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 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:downloadDocumentsAWBs>
         <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:downloadDocumentsAWBs>
   </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 todas as ocorrências disponíveis no sistema no momento da execução, respeitando a quantidade máxima solicitada. Este arquivo XML é composto da seguinte forma:

TAG Tipo Obrigatório Descrição
AWBs root Sim Raiz do xml e composto por lista de AWBs.

AWB

TAG Tipo Descrição
Numero string Número do AWB.
CTe string Número da CT-e
ChaveCTe string Chave da CT-e
NFes element Elemento raiz para a lista de NF-es que compõem o AWB.

NFe

TAG Tipo Descrição
Chave string Chave da NF-e

Exemplo do arquivo XML gerado

<AWBs>
  <AWB>
    <Numero>Exemplo AWB</Numero>
    <CTe>Exemplo CTe</CTe>
      <ChaveCTe>01234567890123456789012345678901234567890123</ChaveCTe>
    <NFes>
      <NFe>
        <Chave>01234567890123456789012345678901234567890123</Chave>
      </NFe>
      <NFe>
        <Chave>01234567890123456789012345678901234567890123</Chave>
      </NFe>
    </NFes>
  </AWB>
  <AWB>
    <Numero>Exemplo AWB 2</Numero>
    <CTe>Exemplo CTe 2</CTe>
    <ChaveCTe>01234567890123456789012345678901234567890123</ChaveCTe>
    <NFes>
      <NFe>
        <Chave>01234567890123456789012345678901234567890123</Chave>
      </NFe>
      <NFe>
        <Chave>01234567890123456789012345678901234567890123</Chave>
      </NFe>
    </NFes>
  </AWB>
</AWBs>