Systax DOCs - Manual de Configuração - Webservice

• Introdução
• Webservice
• Download
• Descrição dos campos da chamada
• Código e descrição dos tipos de documento
• Descrição dos campos de retorno
• Tabela de código (campos "código" e "mensagem" do retorno)
• Exemplo de chamada
• Exemplo de Retorno
• InclusãoDOCs
• Descrição dos campos da chamada
• Tabela de código (campos "código" e "mensagem" do retorno)
• Chamada Envio
• DownloadUnico
• Descrição dos campos da chamada
• Código e descrição dos tipos de documento
• Descrição dos campos de retorno
• Tabela de código (campos "código" e "mensagem" do retorno)
• Exemplo de Chamada
• Exemplo de Retorno

Introdução

Webservice

Download

Descrição dos campos da chamada

Campo	Tipo	Descrição	Obrigatório	Observação
usuario	string	Usuário de acesso ao DF-e	Sim
senha	string	Senha do usuário	Sim
chave	string	ID do Documento	Sim	Obrigatório se, “nsuDfe” não estiver preenchido.
nsuDfe	string	Último NSU retornado pelo sistema	Sim	Obrigatório se, “chave” não estiver preenchido.
dataInicio	string	Data de início no formato yyyy-MM-dd	Não
tipoDocumento	string	Tipo de documento a ser baixado	Sim	Vide tabela Código de descrição dos tipos de documento

Código e descrição dos tipos de documento

Campo	Descrição
0 - Original	Documento original da Nota de Serviço. Podendo ser um PDF, um XML ou até mesmo um JPEG
1 - Email	Texto que veio no e-mail junto com a nota de serviço. Guardamos o texto do e-mail, pois em alguns casos, algumas informações da nota de serviço vêm direto no corpo do e-mail.
2 - Extraído	Informações em um XML, que foram extraídas do arquivo recebido, através de um processo automático que temos
3 - Padrão	Seria o arquivo final, o mesmo que estávamos enviando na versão anterior do WS. Esse arquivo pode sofrer alterações com o tempo, através de processos manuais feitos dentro do DFe.  Sempre que o arquivo é alterado, ele é adicionado novamente na fila com um novo NSU, para que vocês recebam sempre a última versão do arquivo.

Descrição dos campos de retorno

Campo	Descrição
nsu	NSU do DOCs
Id_doc	ID Systax do Documento
nome	Nome do arquivo
file	Documento requisitado

Tabela de código (campos "código" e "mensagem" do retorno)

Código	Mensagem
0	Consulta de status realizada com sucesso
1	Chamada incompleta
2	Usuário e/ou senha inválidos
	Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores.
99	Erro na consulta de status
	Documento " + chamada.chave + " não encontrado no DOCs
999	A operação não pode ser concluída. Contate os administradores

Exemplo de chamada

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe">
<soapenv:Header/>
<soapenv:Body>
<tem:Download>
    <tem:chamadaDownload>
        <wsd:usuario>XXX</wsd:usuario>
          <wsd:senha>XXXX</wsd:senha>
        <wsd:nsuDfe>0</wsd:nsuDfe>
        <wsd:tipoDocumento>Y</wsd:tipoDocumento>
    </tem:chamadaDownload>
</tem:Download>
</soapenv:Body>
</soapenv:Envelope>

Exemplo de Retorno

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <DownloadResponse xmlns="http://tempuri.org/">
         <DownloadResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:documentos>
               <a:Docs>
                  <a:nsu>xxxxx</a:nsu>
                  <a:id_doc>xxxx</a:id_doc>
                  <a:nome>nomedoarquivo.xml</a:nome>
                  <a:file>Conteúdo do arquivo de acordo com o tipo escolhido (Original => Base64; Email => HTML; Extraido => XML; Padrão => XML)</a:file>
               </a:Docs>
            </a:documentos>
            <a:statusGeral/>
         </DownloadResult>
      </DownloadResponse>
   </s:Body>
</s:Envelope> 

InclusãoDOCs

Descrição dos campos da chamada

Campo	Tipo	Descrição	Obrigatório	Observação
usuario	string	Usuário de acesso ao DF-e	Sim
senha	string	Senha do usuário	Sim
documento	string	Arquivo em base string	Sim	base64string
filename	string	Nome do arquivo	Sim

Tabela de código (campos "código" e "mensagem" do retorno)

Código	Mensagem
1	Chamada incompleta
2	Usuário e/ou senha inválidos
	Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores.
0	Operação realizada com sucesso. Protocolos: nnnn
999	A operação não pode ser concluída. Contate os administradores

Chamada Envio

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe.chamada">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:Inclusao>
                 <tem:chamadaInclusaoDocs>
                    <wsd:usuario>xxx</wsd:usuario>
               <wsd:senha>xxx</wsd:senha>
                <wsd:documento> Arquivo em Base64</wsd:documento>
            <wsd:filename>xxx</wsd:filename>
         </tem:chamadaInclusaoDocs>
      </tem:Inclusao>
   </soapenv:Body>
</soapenv:Envelope>

DownloadUnico

Descrição dos campos da chamada

Campo	Tipo	Descrição	Obrigatório	Observação
usuario	string	Usuário de acesso ao DF-e	Sim
senha	string	Senha do usuário	Sim
idDoc	string	ID do documento no sistema	Sim	Obrigatório se, “nsuDfe” não estiver preenchido.
nsuDfe	string	Último NSU retornado pelo sistema	Sim	Obrigatório se, “idDoc” não estiver preenchido.
tipoDocumento	string	Tipo de documento a ser baixado	Sim	Vide tabela Código de descrição dos tipos de documento

Código e descrição dos tipos de documento

Campo	Descrição
0 - Original	Documento original da Nota de Serviço. Podendo ser um PDF, um XML ou até mesmo um JPEG
1 - Email	Texto que veio no e-mail junto com a nota de serviço. Guardamos o texto do e-mail, pois em alguns casos, algumas informações da nota de serviço vêm direto no corpo do e-mail.
2 - Extraído	Informações em um XML, que foram extraídas do arquivo recebido, através de um processo automático que temos
3 - Padrão	Seria o arquivo final, o mesmo que estávamos enviando na versão anterior do WS. Esse arquivo pode sofrer alterações com o tempo, através de processos manuais feitos dentro do DFe.  Sempre que o arquivo é alterado, ele é adicionado novamente na fila com um novo NSU, para que vocês recebam sempre a última versão do arquivo.

Descrição dos campos de retorno

Campo	Descrição
nsu	NSU do DOCs
Id_doc	ID Systax do Documento
nome	Nome do arquivo
file	Documento requisitado
código	Código de status de requisição
mensagem	Mensagem de status de requisição

Tabela de código (campos "código" e "mensagem" do retorno)

Código	Mensagem
0	Consulta de status realizada com sucesso
1	Chamada incompleta
2	Usuário e/ou senha inválidos
	Login falhou, usuário com mais de 1 cliente cadastrado. Contate os administradores.
3	Erro na consulta de status
	Documento " + chamada.chave + " não encontrado no DOCs
999	A operação não pode ser concluída. Contate os administradores

Exemplo de Chamada

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wsd="http://schemas.datacontract.org/2004/07/WSDFe">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:DownloadUnico>
            <tem:chamadaDownloadUnico>
            <wsd:usuario>xxx</wsd:usuario>
            <wsd:senha>xxx</wsd:senha>
             <wsd:idDoc>xxx</wsd:idDoc>
            <wsd:nsuDfe>xxx</wsd:nsuDfe>
                <wsd:tipoDocumento>?</wsd:tipoDocumento>
         </tem:chamadaDownloadUnico>
      </tem:DownloadUnico>
   </soapenv:Body>
</soapenv:Envelope>

Exemplo de Retorno

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <DownloadUnicoResponse xmlns="http://tempuri.org/">
         <DownloadUnicoResult xmlns:a="http://schemas.datacontract.org/2004/07/WSDFe.retorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:documento>
               <a:nsu>xxx</a:nsu>
               <a:id_doc>xxx</a:id_doc>
               <a:nome>nomedoarquivo.xml</a:nome>
               <a:file> Conteúdo do arquivo de acordo com o tipo escolhido (Original => Base64; Email => HTML; Extraido => XML; Padrão => XML) </a:file>
            </a:documento>
            <a:statusGeral>
               <a:codigo>0</a:codigo>
               <a:mensagem>Operação realizada com sucesso.</a:mensagem>
            </a:statusGeral>
         </DownloadUnicoResult>
      </DownloadUnicoResponse>
   </s:Body>
</s:Envelope>