Integrando com o WebHook

Olá! Neste artigo vamos explicar como funciona o cadastro de WebHook via Web Service do InvoiCy.

Para realizar a integração, realize os seguintes passos:

1- Visualize a estrutura WSDL do Web Service

Para visualizar a estrutura WSDL do Web Service, basta copiar e colar o link do Web Service em seu navegador de internet.

Para empresas que utilizam o ambiente de homologação, utilizar o link https://homolog.invoicy.com.br/awebhook.aspx?WSDL. Já para empresas que utilizam ambiente de produção, devem utilizar o link https://app.invoicy.com.br/awebhook.aspx?WSDL.

2- Realize o consumo do Web Service

É preciso consumir o Web Service para realizar a integração. Ao realizar a consumo do WS, você deverá informar 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 de acordo com dados enviados.

É importante destacar que quando for feita alguma ação relacionada a um WebHook de parceiro (que possui mais de uma empresa vinculada), o Hash MD5 precisa ser gerado no seguinte formato: chave de parceiro + XML da requisição.

Para ações em WebHook relacionadas a uma empresa específica, utiliza-se o formato: chave de acesso da empresa + XML da requisição.

• EmpCO: Identificador de PDV.

• EmpCNPJ: CNPJ da empresa.

Quando for realizada uma alteração para um WebHook da empresa, é necessário informar o CNPJ. Caso a alteração seja feita para um WebHook de parceiros, é preciso remover a informação deste campo.

• DadosItem: Conteúdo do XML a ser enviado para o InvoiCy.

Dentro da TAG “DadosItem”, você deverá informar o conteúdo XML da requisição, contendo a estrutura de cadastro, alteração ou consulta do WebHook. Os campos devem ser convertidos para texto.

Para facilitar seu entendimento, disponibilizamos para você o download de um exemplo completo de consumo do WS de recepção. Clique aqui e realize o download do documento.

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

A tag retorna o conteúdo XML do retorno, codificado em “CDATA”. O retorno traz o sucesso ou insucesso da operação, juntamente com a sua descrição.

Agora que você já realizou sua integração, podemos dar prosseguimento ao próximo passo: Cadastro de WebHook via API’s.