Pular para conteúdo

Cadastro de Empresa

Para configurar o cadastro de uma nova empresa ou atualizar ou as informações de uma empresa existente via SOAP, é necessário estabelecer uma comunicação com o Web Service apropriado. Primeiramente, visualize a estrutura WSDL do mesmo:

Em seguida, será preciso realizar o consumo do Web Service para efetuar a integração.

Destacando que, para gerar a chave hash MD5, utilizaremos o mesmo processo da chave de acesso. Sendo necessário, substituir a chave de acesso + XML da requisição, pelo formato: chave de parceiro + XML da requisição, para realizar a concatenação e posteriormente gerar o hash MD5.

Exemplo de Envio

Inicialmente, preencha o XML de envio com as informações necessárias para realizar o cadastro da empresa. Em seguida, é realizada a geração do hash MD5, conforme orientações do artigo de referência.

Além disso, o XML deve ser linearizado, convertido para texto e enviado dentro da tag <inv:Documento>na estrutura SOAP, conforme demonstrado a seguir:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="InvoiCy">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:recepcao.Execute>
         <inv:Invoicyrecepcao>
            <inv:Cabecalho>
               <inv:EmpPK>ABCabcCBAcbaA+CabcCBAc==</inv:EmpPK>
               <inv:EmpCK>8e1f33a3a9c68d9a576d4ce8a7d339e3</inv:EmpCK>
               <inv:EmpCO></inv:EmpCO>
            </inv:Cabecalho>
            <inv:Informacoes>
               <inv:Texto></inv:Texto>
            </inv:Informacoes>
            <inv:Dados>
               <inv:DadosItem>
                  <inv:Documento><!-- (1) --></inv:Documento>
                  <inv:Parametros></inv:Parametros>
               </inv:DadosItem>
            </inv:Dados>
         </inv:Invoicyrecepcao>
      </inv:recepcao.Execute>
   </soapenv:Body>
</soapenv:Envelope>
  1. Neste campo, informe o XML de envio. Para visualizar um exemplo de envio, clique aqui.

Para mais informações sobre a estrutura do layout de integração para cadastro de empresa, clique aqui.

A ativação de outras extensões pode ser realizada através do cadastro da empresa. Para isso, utilize a mesma estrutura das extensões descritas no exemplo ou consulte o artigo da extensão desejada para obter informações detalhadas sobre o processo de ativação no cadastro da empresa.

Exemplo de Retorno

Com o envio da requisição, é necessário realizar a leitura de 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>Solicitação de cadastro de empresa recebida.</Descricao>
                  <Documentos>
                     <DocumentosItem>
                        <Documento><![CDATA[<RetornoCadastro xmlns="InvoiCy"><RetornoCadastro.RetornoItem xmlns="InvoiCy"><Codigo>100</Codigo><Descricao>A empresa foi cadastrada no InvoiCy.</Descricao><EmpAK>7PmxkJHAWEL6Tt1neUBkUd3zhc6smeSm</EmpAK><ChaveCriptografia>9e8ec2c0fc264571998e13269b48152c</ChaveCriptografia></RetornoCadastro.RetornoItem><RetornoCadastro.RetornoItem xmlns="InvoiCy"><Codigo>100</Codigo><Descricao>Extensão Importação de Documentos ativada com sucesso!</Descricao><EmpAK /><ChaveCriptografia /></RetornoCadastro.RetornoItem><RetornoCadastro.RetornoItem xmlns="InvoiCy"><Codigo>100</Codigo><Descricao>Extensão Manifestação do destinatário ativada com sucesso!</Descricao><EmpAK /><ChaveCriptografia /></RetornoCadastro.RetornoItem><RetornoCadastro.RetornoItem xmlns="InvoiCy"><Codigo>100</Codigo><Descricao>Extensão InvoiCy OCR ativada com sucesso!</Descricao><EmpAK /><ChaveCriptografia /></RetornoCadastro.RetornoItem></RetornoCadastro>]]></Documento>
                     </DocumentosItem>
                  </Documentos>
               </MensagemItem>
            </Mensagem>
         </Invoicyretorno>
      </recepcao.ExecuteResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

No caso de sucesso no cadastro da empresa, a chave de acesso e o status de cada processo serão retornados, juntamente com o código de retorno "100" e a mensagem "Solicitação de cadastro de empresa recebida.". No entanto, se ocorrer alguma falha no cadastro, o mesmo será retornado e poderá ser corrigido.

Este artigo encerra a explicação dos parâmetros necessários para realizar o cadastro de empresa. Para dar continuidade na integração, consulte os próximos artigos: