Replicar o cadastro de empresas automaticamente

Última atualização em: 06 de maio, 2021

Essa novidade é para você, usuário parceiro! A partir de agora, permitimos replicar os dados do cadastro de uma empresa entre os ambientes de homologação e produção, flexibilizando as novas integrações.

Essa funcionalidade está disponível através do novo ícone “Replicar empresa”, localizado na tela de Início do InvoiCy, como demonstra a imagem a seguir.

Dessa forma, basta clicar no ícone correspondente a empresa que você deseja enviar o cadastro para o outro ambiente, onde o sistema irá apresentar uma mensagem em tela, solicitando a confirmação para replicar o cadastro da empresa.

• 

Se o cadastro ocorrer com sucesso, será apresentada em tela a mensagem “A empresa foi cadastrada no Invoicy”. Caso contrário, será apresentada uma mensagem informando o que aconteceu.

Atenção! Estando no ambiente de homologação, a empresa será automaticamente cadastrada no ambiente de produção, mas fique tranquilo que isso não acarretará em custos adicionais, pois a empresa ainda não estará licenciada para emitir documentos.

Também é possível fazer o processo inverso, estando no ambiente de produção, a empresa será automaticamente cadastrada no ambiente de homologação.

É importante destacar que, os dados enviados no cadastro compreendem as informações relativas aos dados da empresa (CNPJ, Razão Social, endereços), bem como logomarca e certificado digital. Demais dados como, parâmetros configurados por módulo, caixas de e-mail e licenciamento, não serão replicados para o outro ambiente.

Criptografia da senha do certificado ao cadastrar empresa via WS

Última atualização em: 16 de abril, 2021

Para garantir maior tranquilidade e segurança ao usuário Parceiro a Plataforma InvoiCy faz uso de comunicação via HTTPS, e além disso permite que o Parceiro envie a senha do seu certificado digital de forma criptografada, no momento de efetuar o cadastro de uma empresa via Web Service.

Para isso basta enviar o cadastro da empresa, seguindo o layout padrão do InvoiCy disponível no artigo Cadastrar empresa via Web Service, porém sem enviar os dados do certificado digital.

Para maiores informações visualize a estrutura do layout de integração para cadastro de empresa clicando aqui.

A empresa será cadastrada com sucesso, e no retorno do Web Service o usuário receberá na tag <ChaveCriptografia> uma chave de 32 caracteres, única por empresa. Esta é a chave que deverá ser utilizada pelo Parceiro para efetuar a criptografia da senha do seu certificado digital, usando o método AES.

O método AES trata-se de um Padrão de Criptografia Avançada. Para obter mais informações sobre esse método de criptografia acesse o link https://pt.wikipedia.org/wiki/Advanced_Encryption_Standard.

O próximo passo é criptografar a senha do seu certificado digital, fazendo uso da chave de criptografia obtida no retorno do cadastro da empresa, por meio do método AES, e efetuar a atualização do cadastro da empresa enviando as informações do certificado, juntamente com a senha criptografada.

Ao efetuar a atualização do cadastro da empresa, não é necessário informar todos os dados novamente, basta enviar o CNPJ da empresa juntamente com os dados do certificado, e a nova tag <MetodoCriptografiaSenha>, que deverá ser preenchida com o método utilizado para criptografia da senha, neste caso o método AES. A imagem abaixo demonstra a estrutura que deverá ser enviada para cadastrar o certificado com a senha criptografada.

É importante destacar que esta opção está disponível apenas para o cadastro de empresas via WS, e que enviar o certificado com a senha criptografada é uma escolha do usuário Parceiro, não é uma obrigatoriedade. O cadastro da empresa continuará sendo executado normalmente caso o usuário Parceiro decida enviar o certificado sem criptografar a senha do mesmo, lembrando que mesmo sem criptografar a senha o cadastro será executado com segurança, devido a utilização de comunicação via HTTPS.

Códigos de Retorno Cadastro de Empresa via Web Service

Última atualização em: 14 de agosto, 2019

Neste artigo iremos abordar os possíveis códigos de retorno ao realizar o cadastro de uma empresa através do Web Service do InvoiCy.

Ao realizar o cadastro de uma empresa via Web Service, você usuário poderá obter os seguintes retornos:

100 – Solicitação de cadastro recebida

Ao receber esse retorno significa que a sua empresa foi cadastrada com sucesso no InvoiCy.

101 – Falha na estrutura do XML ou campos obrigatórios não preenchidos

Nessa situação a empresa não foi cadastrada, pois algum dos dados informados não estava de acordo. O usuário receberá o código 101 juntamente com o campo que não foi informado corretamente.

103 – Falha na validação do certificado digital

Esse retorno ocorre quando há uma inconformidade com o certificado digital informado para a empresa, onde a senha pode estar incorreta, a data de validade estar vencida, ou o certificado informado não corresponder a empresa que está sendo cadastrada.

104 – E-mail do usuário é inválido

No momento de cadastrar a empresa, ao informar incorretamente o e-mail do usuário será retornado o código 104.

105 – Campos nome ou senha do usuário não informados

Se ao cadastrar a empresa não for informado corretamente as informações referentes ao nome e senha do usuário será retornado o código 105.

106 – Usuário já cadastrado

Se o usuário informado no momento de cadastrar a empresa já estiver cadastrado será retornado o código 106.

107 – Usuário e senha da caixa de e-mail não informada

Ao cadastrar uma empresa pode-se também configurar uma caixa de e-mail. Será retornado o código 107 quando o usuário e senha da caixa de e-mail não forem informados corretamente.

108 – Não foi possível conectar ao servidor de e-mail informado

Esse retorno irá ocorrer quando o servidor de e-mail informado não estiver de acordo, não possibilitando o acesso ao mesmo.

109 – Empresa Matriz não encontrada

Ao cadastrar uma Filial, quando a empresa Matriz não for encontrada irá retornar o código 109 para o usuário.

115 – A raiz do CNPJ do certificado informado difere da raiz do CNPJ da empresa! O certificado foi cadastrado com sucesso

Ao realizar o cadastro de uma empresa e informar um certificado digital que tenha sua raiz de CNPJ diferente da raiz de CNPJ da empresa cadastrada, será retornada essa mensagem apenas como um aviso, mas o cadastro do certificado será efetuado com sucesso da mesma forma.

173 – Chave de comunicação ou chave de parceiro inválida

O código 173 será retornado quando a chave de comunicação ou a chave de parceiro estiverem inválidas, retornando especificamente para o usuário qual das chaves está incorreta.

Cadastrar empresa via Web Service

Última atualização em: 23 de março, 2021

Neste artigo iremos demonstrar como realizar o cadastro de uma empresa através do Web Service do InvoiCy.

A partir de agora, assumimos que você já leu o artigo Integrar com o InvoiCy NF-e. Caso ainda não tenha lido o artigo, recomendamos que realize a leitura do mesmo, para facilitar o entendimento deste artigo.

O cadastramento da empresa é muito simples. Para que isso se torne possível, siga os seguintes passos:

1. Consumindo o Web Service
Primeiramente, você deve realizar o consumo do Web Service de Cadastro de empresas  – https://homolog.invoicy.com.br/arecepcao.aspx

2. Criar os XML para o envio
O XML deve ser convertido para String, porém, antes disso, deve-se gerar a chave de comunicação empCK. Mas como fazer isso se ainda não temos a chave de comunicação da empresa?

É simples. Neste caso, deve-se utilizar a chave de parceiro (EmpPK) para fazer a concatenação e posteriormente gerar a chave hash MD5.

3. Armazenar os dados de retorno
Caso a empresa seja cadastrada com sucesso, é preciso guardar o Código da Empresa no InvoiCy e a chave de acesso, informações fundamentais para a emissão com a empresa.

Para obter os Layouts de envio e retorno do Cadastro de Empresas, faça o download do arquivo CadastroEmpresa.zip. Nele você encontrará também arquivos XML de exemplo.

O documento XML deve ser convertido para texto, e inserido entre as TAGS do SOAP de envio. Veja abaixo um exemplo:

Nos casos em que for usada uma ferramenta RAD para consumo do Web Service através de componente nativo, por exemplo Visual Studio utilizando Web Reference, a conversão do XML para texto irá ocorrer de forma automática. Para os casos em que o desenvolvedor preferir codificar toda a comunicação sem utilizar componentes, além de ser necessário escrever todo o XML do SOAP, também deverá ser feita a conversão do XML do documento para texto, substituindo os caracteres “<”, “>” e “ “ ” (aspas) por “<”, “>” e “”” respectivamente, de acordo com a tabela da W3C: http://www.w3schools.com/html/html_entities.asp.

Para facilitar a geração do XML de integração, disponibilizamos o XML de envio, que poderá servir como base.

4. Realize a leitura do retorno do cadastro de Empresa
Após o envio do XML, precisamos realizar a leitura do retorno do processamento do cadastro. O retorno recebido segue a seguinte estrutura SOAP:

A estrutura SOAP acima demonstra o retorno do envio de apenas uma empresa.

O seu sistema deve ler o retorno, validando as informações conforme o layout de retorno. O retorno apresentará o status de cada processo, desde o cadastro da empresa, a instalação do certificado, a validação da licença e o cadastro do usuário.

Para saber mais sobre os possíveis códigos de retorno ao cadastrar uma empresa via Web Service, acesse o artigo Códigos de Retorno Cadastro de Empresa via Web Service.