Pular para conteúdo

Consumo do Web Service

Neste artigo, apresentamos as orientações para integrar seu ERP ao InvoiCy.

A integração deve ser realizada por meio do Web Service (WS) correspondente ao serviço desejado. Apesar de existirem diferentes Web Services disponíveis, o processo de integração segue, em geral, a mesma estrutura.

O Web Service principal é o de recepção de documentos, que pode ser utilizado na integração com qualquer módulo do InvoiCy. Para iniciar a integração, siga os passos abaixo:

Visualize a Estrutura WSDL do Web Service

Para acessar a estrutura WSDL (Web Services Description Language) de um Web Service, copie e cole a URL correspondente em seu navegador:

Conforme mencionado anteriormente, os endereços podem variar de acordo com o serviço utilizado.

Realize o Consumo do Web Service

Para realizar a integração, será necessário consumir o Web Service (WS) do InvoiCy. Durante o consumo, deverão ser informados os seguintes parâmetros:

  • EmpPK: Chave de Parceiro disponibilizada pela Migrate para cada cliente. A chave de parceiro é gerada por nosso Sistema de Gestão no momento que a sua empresa é cadastrada como nosso parceiro. A mesma será enviada por e-mail e utilizada para controlar as empresas de clientes finais que utilizarão licenças adquiridas pela sua empresa.

  • EmpCK: Código HASH gerado em formato MD5, com base nos dados enviados. Consulte o artigo "Código hash MD5" para mais informações.

  • EmpCO: Identificador de PDV.

  • EmpCNPJ: CNPJ da empresa, com uso exclusivo para o WebHook.

  • Texto: Campo de uso interno do InvoiCy. Não é necessário o preenchimento.

  • Documento: Conteúdo do XML a ser transmitido ao InvoiCy. Dentro desta, você deverá informar o conteúdo XML da requisição. Os campos do XML devem ser convertidos para texto. Caso seja necessário enviar mais de um documento, deve-se repetir esta tag, incluindo em cada ocorrência o conteúdo de um documento distinto.

  • Parametros: Parâmetros com algumas configurações do documento de envio.

Para auxiliar no processo, disponibilizamos um exemplo completo de consumo do WS de recepção, que pode ser acessado clicando aqui.

Realize a Leitura do Retorno

Após o envio da requisição, é necessário realizar a leitura do retorno do processamento. O retorno recebido segue a seguinte estrutura SOAP:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body>
      <recepcao.ExecuteResponse xmlns="InvoiCy">
         <Invoicyretorno>
            <Mensagem>
               <MensagemItem>
                  <Codigo>100</Codigo>
                  <Descricao>Documentos processados</Descricao>
                  <Documentos>
                     <DocumentosItem>
                        <Documento><![CDATA[<Documento><DocModelo>NFe</DocModelo><DocNumero>1</DocNumero><DocSerie>1</DocSerie><DocChaAcesso>43250906312976999149557600000012391001820706</DocChaAcesso><DocProtocolo>143299993012305</DocProtocolo><DocEvenSeq>0</DocEvenSeq><DocEveTp>0</DocEveTp><DocEveId /><DocPDFBase64 /><DocPDFDownload /><DocDhAut>2025-09-11T09:43:03-03:00</DocDhAut><DocDigestValue>9sOmzq+2S/Hp11z1eVheml1jyX9=</DocDigestValue><DocXMLBase64>PG5mZVByb2MgdmVyc2FvPSI0LjAwIiB4bWxucz0iaHR0cDovL3d3dy5wboKzFTL0hyNjN6OGVWaGVtbDZjeVg4PTwvZGlnVmFsPjxjU3RhdD4xMDA8L2NTdGF0Pjx4TW90aXZvPkF1dG9yaXphZG8gbyB1c28gZGEgTkYtZTwveE1vdGl2bz48L2luZlByb3Q+PC9wcm90TkZlPjwvbmZlUHJvYz4=</DocXMLBase64><DocXMLDownload/><DocImpressora /><Situacao><SitCodigo>100</SitCodigo><SitDescricao>Autorizado o uso da NF-e</SitDescricao></Situacao></Documento>]]></Documento>
                     </DocumentosItem>
                  </Documentos>
               </MensagemItem>
            </Mensagem>
         </Invoicyretorno>
      </recepcao.ExecuteResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Este artigo encerra a explicação dos parâmetros necessários para o consumo. Para dar continuidade na integração, consulte o seguinte artigo: Cadastro de Empresa via Web Service.