Um Web service é uma solução tecnológica criada para integrar sistemas de informação, algo muito importante em uma implementação de BPM. No HEFLO, utilizamos o Conector de Web Services como uma extensão do BPM, que permite implementar trocas de mensagens com esta tecnologia para:
- Iniciar um processo (operação de “captura”).
- Consumir web services de terceiros (operação de “lançamento”).
O HEFLO utiliza uma abordagem moderna de web services baseada em REST (Representational State Transfer). Esta estratégia é também a mais leve e permite o uso em aplicativos de integração tais como Zapier e Pluga.
Troca de dados
Todos os dados transferidos entre o aplicativo de terceiro e o HEFLO devem utilizar o formato JSON (Javascript Object Notation ou Notação de Objetos JavaScript), que é um padrão para desenvolvimento de sistemas. O HEFLO disponibiliza diálogos e facilitadores para realizar toda a configuração e o conhecimento técnico requerido é mínimo.
Na configuração do web service existe facilidade para mapear parâmetros do web service de e para campos do item de trabalho. Veja um exemplo de configuração de um web service que inicia um processo.
Em caso de uma chamada realizada pelo HEFLO, todos os parâmetros são consolidados e enviados da seguinte forma:
- Em requests do tipo GET, o sistema consolida esses dados na QueryString da URL.
- Em caso de chamadas do tipo POST, o conteúdo é gerado em formato JSON e enviado no ‘Body’ do request
Autorização e chaves de API
Para que um aplicativo de terceiro faça uma chamada para um web service do HEFLO você precisará fornecer uma chave de aplicativo (API Key). Esta chave é obtida na pagina de Gerenciamento de Ambiente e você pode utilizar os seguintes passos para gerar uma nova:
- Acesse a página de Gerenciamento do Ambiente.
- Na região de “Chaves de API” clique no botão “Adicionar Nova Chave”.
- Copie os dados apresentados no diálogo para o programa que fará a chamada.
- Baixe o arquivo da chave e mantenha em local seguro. Atenção para a observação abaixo!
Uma vez gerada a chave, esta é mantida no nosso servidor com chave irreversível. Isto significa que não é possível relembrar a senha e se você perder esta senha será necessário regerar a chave e realizar a manutenção em todos os programas chamadores mantidos por você. Portanto, ao gerar a chave salve o arquivo texto em local seguro!
A chave de API pode ser incluída no link ou no conteúdo da mensagem web service. Vale lembrar que todas as chamadas serão realizadas com o protocolo de segurança HTTPS, e todos os dados transmitidos são criptografados.