Instalando OMNILINK - Passo a passo

O OMNILINK é um software que deve ser instalado por sua operadora. Para que sua instalação seja realizada, é necessário que sua empresa siga alguns passos, e atenda alguns pre-requisitos.

Abaixo vamos identificar todos os itens que são necessários, bem como um passo-a-passo para instalação dessa ferramenta.

Para informações sobre o que é o OMNILINK, siga esse link: https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2404483085

 

Passo 1: verificando disponibilidade de hardware e configurações de segurança / redes:

O OMNILINK é instalado dentro de sua estrutura de servidores. Sua instalação exige um servidor (virtual ou física) com determinados requisitos de hardware e software.

Os requisitos em resumo são:

  • Hardware (servidor) compatível, com especificações mínimas em conformidade com o requisitado pela Mobile Saúde;

  • Sistema operacional suportado pela aplicação, em conformidade com o especificado pela Mobile Saúde;

  • Docker instalado no servidor compatível;

  • Certifique-se que possui acesso remoto a este computador, e que seu usuário seja capaz de executar comandos de terminal, copiar e colar comandos no terminal deste servidor;

  • Liberação de portas para acesso externo (internet), também conforme especificação;

  • Endereço IP externo que foi liberado no seu firewall;

  • Servidor deve ter acesso a mesma rede do banco dxe dados da sua aplicação/

Para acessar a lista completa de requisitos, siga esse link: https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2404384772

Revise se todos os itens aqui relacionados estão disponíveis. Caso não estejam, providencie a correção / ajuste antes de iniciar o procedimento de instalação.

 

Passo 2: obtendo com seu DBA os acessos do usuário do OMNILINK ao seu Banco de Dados:

Para se conectar ao seu banco de dados, o OMNILINK precisará de um usuário/senha de banco, e das configurações de conexão ao banco de dados. Crie um documento com as seguintes informações e deixe-as a mão ANTES de executar a instalação do OMNILINK:

  • Fabricante do SGDB: (MySQL, Oracle, MSSQL, POSTGRES)

  • Host

  • Porta

  • Database

  • Schema

  • User

  • Pass

Importante: o OMNILINK poderá ser conectado a bancos de dados de produção ou homologação simultaneamente, através de instâncias de instalação. Obtenha as credenciais e configurações para todos os bancos de dados que sua empresa deseja conectar.

 

Passo 3: acessando o painel público do Mosia Omnichannel e gerando SCRIPT de instalação:

  • Abra seu navegador e acesse o seguinte link para acessar o painel público: https://painel.mosiaomnichannel.com.br/

    • Informe a chave do cliente, login e senha. Caso não tenha, entre em contato com o adminstrador da conta (cliente) para receber uma chave de acesso.

  • Uma vez autenticado, acesse a opção FERRAMENTARIA => OMNILINK. Escolha a opção “Nova configuração”. Na tela seguinte, informe os dados conforme orientações abaixo:

    • Nome: informe um nome para sua conexão. Indicamos usar HMG para conexões a bancos de homologação, ou PRD para instâncias de OMNILINK integradas a bancos de produção. Importante: uma vez que o conteiner esteja instalado, serão adicionados prefixos a esse nome, facilitando o entendimento.

    • Endereço: informe o IP e a porta EXTERNA onde o OMNILINK estará disponível. Você também pode usar um domínio ou subdomínio. Exemplo: 200.123.456.789:26801 para configurar uma instância de HMG de autenticação, ou minhaapideboletos.minhaoperadora.com.br:26806 para uma instância de produção boletos do OMNILINK.

    • Versão: escolha a versão mais atual disponível;

    • Módulo: selecione o módulo de OMNILINK que será instalado;

    • Chave de API (opcional): Na necessidade de criar uma camada a mais de segurança em sua aplicação, para saber mais clique aqui.

    • Modo debug: quando ativado, o OMNILINK gera logs no conteiner, para análise de eventuais problemas ou visualização das consultas em banco de dados executadas. Recomendamos que você ative somente em ambientes de HMG, por questões de performance e espaço. Se necessário ativar em PRD, lembre-se de desativa-lo (reinstalando o OMNILINK e configurando-o para DESATIVADO).

    • CONFIGURAÇÕES ADICIONAIS - são modificadas conforme módulo do OMNILINK. Siga as orientações em tela, conforme o módulo escolhido.

    • BANCO DE DADOS: Preencha as informações solicitadas em tela. Essas informações de banco de dados não são gravadas em nenhum lugar, são apenas utilizadas para geração do script automatizado de instalação e configuração do OMNILINK.

    • IMPORTANTE: Não pressione SALVAR ainda. Pressione INSTRUÇÕES DE INSTALAÇÃO.

      • Leia as instruções e role a tela até achar o botão “COPIAR”. Preencha-o.

    • Acesse o servidor via terminal SSH com um usuário com permissões de instalação, e execute o SCRIPT copiado anteriormente. O OMNILINK será executado automaticamente.

    • Após instalação do OMNILINK, volte ao painel e baixe a collection do POSTMAN para iniciar os testes de conexão a partir de seu computador.

    • Salve a configuração da instância pressionando o botão SALVAR.

Caso aconteça algum problema de download e a instalação parecer congelada, execute o comando # docker system prune -a para limpar as tentativas. A seguir, execute novamente o SCRIPT de instalação para reinicia-la.

 

Passo 4: testando a conexão:

  • Acesse o terminal linux do seu servidor e execute o comando:

# docker ps

A saída desse comando deve ser semelhante a essa:

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 7f2ca9c29123 382631017719.dkr.ecr.sa-east-1.amazonaws.com/omni_link:1.0.0_alpha "/bin/sh -c 'node di…" 4 days ago Up 4 days 0.0.0.0:26801->80/tcp omnilink_auth_HMG
  • Abra o postman e importe a collection. Configure a variável de ambiente “host”;

  • Procure pelo request Health-check, e execute-o. A saída deve ser semelhante a esta:

{ "success": true, "version": "1.0.0", "message": "I'm fine.", "name": "OmniLink" }

Em casos onde existe firewall habilitado com filtro de IPs de origem, sua máquina pode ser bloqueada, e o health-check pode exibir uma mensagem de timeout. Certifique-se que seu IP esteja liberado, e a conexão de seu computador esteja com rotas de internet válidas para a API do OMNILINK. Caso seja impossível liberar seu IP para executar a verificação, prossiga para a configuração das APIs do OMNILINK no painel público

 

Caso não receba a mensagem de funcionamento, verifique se o conteiner está em execução, ou se o usuário de banco de dados continua ativo. Habilite o modo DEBUG caso esteja desativado e investigue os motivos das falhas através do comando: # docker logs -f nome_da_sua_instancia_OMNILINK (o mesmo que aparece na coluna NAMES do comando docker ps

 

Passo 5: configurando as integrações:

1 - Acesse o configurador (como acessar o configurador? clique aqui)

2 - Configure as integrações utilizando a opção FUNCIONALIDADES => CONFIGURADOR DE FUNCIONALIDADES.

Pressione o botão EDITAR para editar as configurações de SANDBOX. Escolha as opções desejadas conforme a lista abaixo:

Configurador de funcionalidades

Pressione EDITAR (ou o ícone de lápis) ao lado de cada uma das opções. Isso fará com que você possa configurar a integração, “direcionando” cada uma delas para um serviço do OMNILINK. Será necessário entrar OPÇÃO POR OPÇÃO, individualmente, realizando as configurações listadas abaixo.

Ao pressionar o botão EDITAR, serão apresentados 4 passos (steps) definidos abaixo

  • Step 1: Configuração de Autorização:

    • DEIXAR EM BRANCO, NÃO UTILIZAR PARA OMNILINK. Basta pressionar o botão “Próximo” para seguir a diante.

  • Step 2: Validação:

    • URL do Webservice: utilize sempre o padrão URL do OMNILINK+porta + API disponibilizada. Segue lista de métodos do OMNILINK disponíveis atualmente:

      • Autenticação:

        • Login: {{host}}/authentication/login

        • Pre Load Data: {{host}}/form/preLoadData - necessário pressionar botão LOGIN para configurar essa integração - parte superior direita da tela

          • Importante: informe funcionalidade 16 (Atualização cadastral) no campo de funcionalidade

        • Recuperar Senha Identificação: {{host}}/authentication/recuperarSenhaIdentificacao

        • Recuperar Senha Nova Senha: {{host}}/authentication/recuperarSenhaNovaSenha

        • Trocar senha: {{host}}/authentication/trocarSenha - necessário pressionar botão LOGIN para configurar essa integração - parte superior direita da tela

        • Primeiro acesso: {{host}}/authentication/novoUsuario

        • Beneficiários: Acesso funcionalidade: {{host}}/authentication/grupoFamiliar

      • Extratos / Débitos / Declarações - necessário pressionar botão LOGIN para configurar essa integração - parte superior direita da tela

        • Extrato de utilização:

          • Extrato: {{host}}/extratoUtilizacao/extrato

        • Extrato de coparticipação:

          • Extrato: {{host}}/extratoCoparticipacao/extrato

        • Declarações:

          • Lista de declarações: {{host}}/declaracao/listarDeclaracoes

          • Detalhes de uma declaração: {{host}}/declaracao/declaracaoPdf

        • Débitos:

          • Lista de débitos: {{host}}/debitos/listaDebitos

          • Detalhe dos débitos: {{host}}/debitos/detalheDebito

          • Boleto em PDF: {{host}}/debitos/boletoPdf

          • Resumo da cobrança: {{host}}/debitos/resumoCobranca

          • Gerar boleto: {{host}}/debitos/gerarBoleto

    • Exemplo:

    • Pressione o botão “Adicionar Header” e insira 3 novos headers, com os seguintes conteúdos:

      • Header: ambiente / Valor: 1

      • Header: idOperadora / Valor: 1

      • Header: idConfigClienteApp / Valor: 1

    • Configure o timeout para 10

    • Informe os dados que o formulário requer no box da direita, logo acima do botão “Validar integração”.

    • Uma vez que os dados do formulário estiverem preenchidos, pressione o botão “VALIDAR INTEGRAÇÃO”. Nesse momento, a API do OMNILINK será consumida, e os resultados serão exibidos nos espaços “Retorno do Webservice” e “Retorno da Validação”.

A validação pode retornar resultado positivo, indicando ZERO ERROS ou negativo, indicando falhas. Em caso de FALHAS, o botão “Próximo” estará DESABILITADO. Será necessário investigar e corrigir as falhas antes de tentar novamente.

Para analisar as falhas, recomendamos verificar o log do OMNILINK, através do comando de análise de logs (# docker logs -f nome_da_sua_instancia_OMNILINK)

Em algumas integrações (Trocar senha, por exemplo) exigem que você faça um login ANTES de fornecer a nova senha. Esse comportamento é exigido de acordo com o contexto.

 

  • Step 3: Confirmação:

    • Analise os dados gerados e pressione PROXIMO.

 

  • Step 4: Recibo:

    • Nessa etapa, é gerado um recibo que comprova a estrutura enviada, o retorno e os parâmetros de cabeçalho. Verifique o conteúdo e finalize o processo de configuração.

Lembre-se: você deve repetir esse processo para cada integração.

 

Passo 6: acessando o app SANDBOX:

  • Baixe o app SANDBOX utilizando a URL https://sandboxapp.mosiaomnichannel.com.br/#/

  • Informe seu client key, usuário e senha. São as mesmas credenciais utilizadas para acessar o painel público.

  • Na tela de login da sua operadora, informe um login válido (utilize o mesmo que foi utilizado para configurar o login, por exemplo).

  • No momento do login, o usuário / senha informados serão repassados pelo app para o OMNILINK, que por sua vez fará as consultas nas suas views e devolverá o resultado para o app.

  • Acesse demais funcionalidades do app que exijam integração realizada pelo OMNILINK (Boletos, extratos de utilização, extrato de coparticipação, declarações, ou mesmo crie um novo acesso, troque senha, etc). Fazendo isso vc estará testando todas as integrações disponíveis, e tendo certeza que todas as suas funções estão em perfeito funcionamento.

Caso encontre algum problema, sempre volte ao terminal linux e execute o comando de visualização de logs. Se os logs não estiverem ativos, refaça a configuração do OMNILINK pelo painel, ativando a opção LOGS e repita a operação de testes. Assim você conseguirá identificar eventuais problemas e soluciona-los.